Skip to content

Commit a01b6b6

Browse files
authored
Update README.md
Change references to poetry and update structure
1 parent 30012ce commit a01b6b6

File tree

1 file changed

+11
-35
lines changed

1 file changed

+11
-35
lines changed

README.md

Lines changed: 11 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,11 @@
33

44

55
# Nbed
6-
76
This package implements projection-based embedding methods to reduce the size of a molecular Hamiltonain via embedding in DFT. Output qubit hamiltonains can be solved by a suitable quantum algorithm.
87

98
Nbed uses PySCF as a backend for chemistry caluculations, which is not supported on Windows. Alternative chemistry backends are planned, however in the mean time this package will work only for Linux and MacOS.
109

1110
## Documentation
12-
1311
Full documentation is available at [https://nbed.readthedocs.io](https://nbed.readthedocs.io).
1412

1513
## Installation
@@ -20,21 +18,19 @@ The package is available on [PyPI](https://pypi.org/project/nbed/) and can be in
2018
```
2119
pip install nbed
2220
```
23-
### Poetry
2421

25-
Development of Nbed uses the packaging and dependency manager Poetry, to install it from the command line run::
26-
27-
pip install poetry
22+
### Dependencies
2823

24+
Development of Nbed uses the packaging and dependency manager uv, to install it from the command line run::
25+
```shell
26+
pip install uv
27+
```
2928
with this installed, you can start working on the package by running:
29+
```shell
30+
uv venv .venv/
31+
uv pip install .
32+
```
3033

31-
poetry install
32-
33-
which will create a virtual environment with the required dependencies.
34-
35-
This virtual environment subsequently can be activated with:
36-
37-
poetry shell
3834
## Use
3935

4036
The package has three main interfaces, each to the same function `embed/nbed`.
@@ -121,38 +117,18 @@ from nbed import load_hamiltonian
121117
qham = load_hamiltonian(<path to hamiltonian JSON>, <output type>)
122118
```
123119

124-
## Structure
125-
126-
```
127-
Nbed
128-
docs_source
129-
nbed
130-
notebooks
131-
logs
132-
tests
133-
```
134-
### nbed
135-
136-
Main functionality of the package.
120+
## Overview
137121

138122
- `embed.py` - main functionality
139123
- `driver.py` - Class which carries out the algorithm. Main point of access for functionality.
140124
- `ham_converter.py` - class to convert between Hamiltonian formats as well as save to and read from JSON.
141125
- `ham_builder.py` - class to build Hamiltonians from quantum chemistry calculations.
142126
- `localizers/` - Classes which perform localization.
143-
- `mol_plot.py` - functions to plot the systems localised molecular orbitals.
144127
- `utils.py` - log settings and cli parsing.
145128

146-
### Notebooks
129+
## Examples and Explainers
147130
This [folder](https://github.com/UCL-CCS/Nbed/tree/master/docs/source/notebooks) contains jupyter notebooks which explain the embedding procedure in detail, including relevant theory. Notebooks to replicate results presented in publications can also be found here.
148131

149132

150-
### Tests
151-
152-
Contains all tests of the package. These can be run from the command line using `pytest`.
153-
154-
### Logs
155-
Each time the package is initialised a new log will be started in the top level director at `Nbed/.nbed.log`.
156-
157133
## Development
158134
If you would like to contribute to this code base please first create an issue and a fork of the repo from which to make your pull request.

0 commit comments

Comments
 (0)