In addition, you may want to install:
pip install git+https://github.com/mhvk/scintillometry.git#egg=scintillometry
--user if you installing for yourself outside of a virtual
environment, and/or with a trailing
[all] to also install the optional
dependencies (which currently excludes PINT, since it does not work with
Obtaining Source Code¶
The source code and latest development version of Scintillometry can found on its GitHub repo. You can get your own clone using:
git clone email@example.com:mhvk/scintillometry.git
Of course, it is even better to fork it on GitHub, and then clone your own repository, so that you can more easily contribute! From within the cloned repository:
pip install .
Here, apart from the
--user option and possible
you may want to add the
--editable option to just link to the source
repository, which means that any edit will be seen.
Running Code without Installing¶
As Scintillometry is purely Python, it can be used without being built or
installed, by appending the directory it is located in to the
environment variable. Alternatively, you can use
sys.path within Python
to append the path:
import sys sys.path.append(SCINT_PATH)
SCINT_PATH is the directory you downloaded or cloned
Testing the Installation¶
pip install -e .[test]
Then, inside the root directory, simply run
or, inside of Python:
import scintillometry scintillometry.test()
For further details, see the Astropy Running Tests pages.
As with Astropy, building the documentation is unnecessary unless you are writing new documentation or do not have internet access, as Scintillometry’s documentation is available online at scintillometry.readthedocs.io.
pip install -e .[docs]
Then, go to the
docs directory and run
For further details, see the Astropy Building Documentation pages.