Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sunqm committed Oct 30, 2024
1 parent 845af07 commit 4c36c86
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,8 @@ pyscf-forge
└── kuhf.py
```

4. There may exist scenarios that the directory you plan to create already exists within `pyscf`.
### Path Conflicts
There may exist scenarios that the directory you plan to create already exists within `pyscf`.
For example, if you want to add a new method, like `pp_rpa.py`, to the `pyscf/tdscf` folder,
this could conflict with the existing `pyscf.tdscf` module in the pyscf core repository.
Adding features to existing modules requires more complex configuration.
Expand Down Expand Up @@ -128,3 +129,9 @@ pyscf-forge
└── tdscf // no __init__.py file in pyscf-forge
└── pp_rpa.py
```

When installing the `pyscf-forge` wheels using `pip install` in the normal
installation mode, the `pp_rpa.py` file will be added to the `pyscf/tdscf`
folder, integrating seamlessly as part of the regular `pyscf` module.
After this standard installation, there is no need to adjust the `__path__`
attribute, as all features and modules are located within the same directory.

0 comments on commit 4c36c86

Please sign in to comment.