In addition, you may want to install:
To install Baseband-tasks with pip, run:
pip3 install baseband-tasks
--user if you installing for yourself outside of a virtual
environment, and/or with a trailing
[all] to also install the optional
[io] for just HDF5 support).
Baseband-tasks was originally developped under the name
It was never put on PyPI under that name, but
could be downloaded from github. If you have old scripts that depend
on that name and want these to work without (yet) changing imports,
you can install the last version under the
pip install git+https://github.com/mhvk/baseband-tasks.git@scintillometry#egg=scintillometry
Obtaining Source Code¶
The source code and latest development version of Baseband-tasks can found on its GitHub repo. You can get your own clone using:
git clone email@example.com:mhvk/baseband-tasks.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 Baseband-tasks 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(PACKAGE_PATH)
PACKAGE_PATH is the directory you downloaded or cloned
python3 setup.py egg_info
Testing the Installation¶
pip install -e .[test]
Then, inside the root directory, simply run
or, inside of Python:
import baseband_tasks baseband_tasks.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 Baseband-tasks’s documentation is available online at baseband.readthedocs.io/project/baseband-tasks.
pip install -e .[docs]
Then, go to the
docs directory and run
For further details, see the Astropy Building Documentation pages.