Installation Guide¶
To install this package we assume you have a Python environment set up, into which you can install packages via pip. If this isn't the case, we recommend installing the Anaconda python distribution, and using conda to manage the version(s) of python you have installed on your computer. One (of many) tutorials about how to get started with Python is available here.
Basic Installation¶
To install this code run:
pip install git+https://github.com/catrionamurray/chromatic_fitting
which should install the chromatic_fitting package as well as any necessary dependencies. If you already have chromatic_fitting already installed but need a newer version then run:
pip install --upgrade git+https://github.com/catrionamurray/chromatic_fitting
Developer Installation¶
If you would like to be able to dive into, edit, or develop this code then we recommend you fork and/or clone the github repository onto your own computer:
git clone https://github.com/catrionamurray/chromatic_fitting.git
cd chromatic_fitting
pip install -e '.[develop]
Including the [develop] after the . will install both the dependencies for the package itself and the extra dependencies required for development (= testing and documentation).
You can quickly test whether your installation worked, and what version you have, by running the Python code:
import chromatic_fitting
chromatic_fitting.version()
Running on Python v3.8.13 (default, Mar 28 2022, 06:13:39) [Clang 12.0.0 ] Running on numpy v1.22.1
'0.2.3'
Enjoy!