cavity quantum electrodynamic system simulations
This package fully supports Windows, along with Linux and macOS, but Python is typically
installed differently on Windows.
Windows users typically access Python through the
py launcher rather than a python3
link in their PATH. Within a virtual environment, or when using conda, all platforms operate the same and use a
python link to access the Python version used in that virtual environment.
Python 3.6+.
Dependencies are defined in:
requirements.inrequirements.txtdev-requirements.indev-requirements.txt
It is best practice during development to create an isolated
Python virtual environment using the
venv standard library module. This will keep dependant Python packages from interfering
with other Python projects on your system.
On *Nix:
$ python3 -m venv venv
$ source venv/bin/activateOn Windows cmd:
> py -m venv venv
> venv\Scripts\activate.batOnce activated, it is good practice to update core packaging tools (pip, setuptools, and
wheel) to the latest versions.
(venv) $ python -m pip install --upgrade pip setuptools wheelThis project uses pip-tools to lock project dependencies and create reproducible virtual environments.
Note: Library projects should not lock their requirements.txt. Since python-blueprint
also has a CLI application, this end-user application example is used to demonstrate how to
lock application dependencies.
To update dependencies:
(venv) $ python -m pip install pip-tools
(venv) $ python -m piptools compile --upgrade requirements.in
(venv) $ python -m piptools compile --upgrade dev-requirements.inAfter upgrading dependencies, run the unit tests as described in the `Unit Testing`_ section to ensure that none of the updated packages caused incompatibilities in the current project.
To cleanly install your dependencies into your virtual environment:
(venv) $ python -m piptools sync requirements.txt dev-requirements.txt