Install¶
Dependencies¶
Installation¶
(Optional) Create a virtual environment.
Install
pip install risb
Uninstall¶
pip uninstall risb
Docker¶
There is a Dockerfile and docker-compose.yml inside the docker folder.
The Dockerfile will pull the
TRIQS docker image
from the hub and install risb. Using the image will be the same as outlined in
the install instructions.
To connect to the Jupyter notebook it is
localhost:8888/?token=put/token/here
You can find the token by attaching a shell to the container and running
jupyter server list
There is also a development Dockerfile.dev and the corresponding
docker-compose-dev.yml in order to have a container to develop code. It
installs TRIQS from source, and works on
Apple M1/M2 (arm64, aarch64), and any amd64 system.
Tests¶
The tests require a working TRIQS installation.
Clone source
git clone https://github.com/thenoursehorse/risb
cd risb
Install the prerequisites
pip install -e .[test]
Tests are run with
pytest
Documentation¶
Clone source
git clone https://github.com/thenoursehorse/risb
cd risb
Install the prerequisites
pip install -e .[docs]
Build the API
sphinx-apidoc -o docs/api --module-first --no-toc --force --separate src/risb
Build the documentation and set up a local server
sphinx-autobuild -b html docs docs/_build
Access through a browser at http://127.0.0.1:8000.