Installation

Pre-requisites

The following software will be required to install and run maser4py:

  • Python 3 and pip tool (tested on Python 3.8, 3.9 and 3.10)

  • git tool is needed to get source files

  • poetry package is recommended to install the package from source files

Using pip

To install the full package, run the following command:

pip install maser4py[all]

If the installation has ended correctly, the following command should return the maser4py version:

maser --version

It is also possible to choose the submodules to install.

For instance, to install only maser-data and maser-plot submodules:

pip install maser4py[data,plot]

Following options are currently available:

  • data to get maser-data submodule features

  • plot to get maser-plot submodule features

  • tools to get maser-tools submodule features

  • jupyter to install Jupyter for notebook support

  • jupytext to install Jupyter for notebook text support

  • all to install all the submodules above

From source files

To retrieve maser4py source files:

git clone https://gitlab.obspm.fr/maser/maser4py.git

Note

The master branch will be retrieved by default. Use --branch develop option to get the development version.

Then install poetry package:

pip install poetry

Finally install maser4py package, executing the following command from the maser4py main directory:

poetry install

Note

By default poetry will install package in the editable mode. See poetry manual for more details.