diff --git a/README.md b/README.md index 655aa6b299e5536590959a5d462839b41aaccb30..dcce9caecac035e461c25bf9808139a306b10b91 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,28 @@ # Optical Lattices Python Library -Simulate parameters and interference patterns of optical lattices and simulate loading of a Fermi gas from an optical dipole trap. +Simulate parameters and interference patterns of optical lattices and +simulate loading of a Fermi gas from an optical dipole trap. -Install via `pip install git+https://gitlab.physik.uni-muenchen.de/A.Impertro/optical-lattices.git` +## Installation -Or when cloned locally cd into repo folder and execute `pip install -e .` +You can install `optical_traps` directly via pip + +```shell +$ pip install git+https://gitlab.physik.uni-muenchen.de/A.Impertro/optical-traps.git +``` + +If desired, you can install the optional dependency +[`fdint`](https://pypi.org/project/fdint/), which +allows calculations involving Fermi-Dirac integrals to be performed +faster. + +```shell +$ pip install git+https://gitlab.physik.uni-muenchen.de/A.Impertro/optical-traps.git[fdint] +``` + +In development, you can install the module from your local +repository by running + +```shell +$ pip install -e . +``` diff --git a/requirements.txt b/requirements.txt deleted file mode 100644 index c58f7cb09c891de8d53476b7dbe38ef4f7819bfb..0000000000000000000000000000000000000000 --- a/requirements.txt +++ /dev/null @@ -1 +0,0 @@ --r requirements/common.txt diff --git a/requirements/common.txt b/requirements/common.txt index 5d74f4b5972c6c3b704f88a9682eb616bfdf4a7a..73608e1df1dfd47ec7ec880372a2aeaa9b7f197b 100644 --- a/requirements/common.txt +++ b/requirements/common.txt @@ -1,4 +1,3 @@ numpy>1.17 -fdint>2.0 scipy>1.3 -matplotlib \ No newline at end of file +matplotlib diff --git a/setup.py b/setup.py index 96e5b35767d0ec19b538dc87b68662562b2e8945..489f6e18665040093bd153b74c07ee7fd75e33f1 100644 --- a/setup.py +++ b/setup.py @@ -17,7 +17,7 @@ here = path.abspath(path.dirname(__file__)) with open(path.join(here, 'README.md'), encoding='utf-8') as f: long_description = f.read() -with open(path.join(here, 'requirements' , 'common.txt'), encoding='utf-8') as f: +with open(path.join(here, 'requirements', 'common.txt'), encoding='utf-8') as f: required = f.read().splitlines() @@ -80,10 +80,9 @@ setup( # dependencies). You can install these using the following syntax, # for example: # $ pip install -e .[dev,test] - #extras_require={ - # 'dev': ['check-manifest'], - # 'test': ['coverage'], - #}, + extras_require={ + 'fdint': ['fdint>2.0'] + }, # If there are data files included in your packages that need to be # installed, specify them here. If using Python 2.6 or less, then these