The common library for all Meteor Research Group scripts. This library includes all metrec data interfaces, common astronomical routines, and utility classes.
Project description
The common library for all Meteor Research Group scripts. This library includes all metrec data interfaces, common astronomical routines, and utility classes.
Requirements
python 2.7, >=3.4
It is recommended to work with a dedicated Python virtual environment for this project. The sections below demonstrate how to create a virtual environment in the user’s home directory under the venv directory.
Ubuntu
sudo apt-get install virtualenv
mkdir ~/venv
cd ~/venv
virtualenv -p python3 mrg_py3
Windows
Download git from and Python 64-bit versions from,
and install it taking defaults.
Create a Python virtual environment,
c:\Python36\Scripts\pip.exe install virtualenv
mkdir %HOMEPATH%\venv
cd %HOMEPATH%\venv
c:\Python36\python.exe -m virtualenv mrg_py3
To activate and deactivate the newly created virtual environment using the following commands,
%HOMEPATH%\venv\mrg_py3\Scripts\activate.bat
deactivate
Installation
First activate the virtual environment before executing the following commands.
Install as end-user
If there is no need to modify the source code, then it is recommended to install the latest release from the official Python PyPI server.
pip install --upgrade mrg_core
Install from source
For developers of this package, the project source code should be installed using git. Then the dependencies may be installed in the virtual environment using the pip install commands.
Windows
Download and install git from,
mkdir ~/PycharmProjects
cd ~/PycharmProjects
git clone https://gitlab.com/mrg-tools/mrg_test_data.git
git clone https://gitlab.com/mrg-tools/mrg_core.git
pip install -r requirements.txt
pip install -r requirements-dev.txt
Ubuntu
sudo apt-get install git
mkdir ~/PycharmProjects
cd ~/PycharmProjects
git clone https://gitlab.com/mrg-tools/mrg_test_data.git
git clone https://gitlab.com/mrg-tools/mrg_core.git
pip install -r requirements.txt
pip install -r requirements-dev.txt
Developer Commands
Activate the virtual environment.
To run the unittests,
cd ~/PycharmProjects/mrg_core
pytest
To run the pylint,
cd ~/PycharmProjects/mrg_core
pylint --rcfile pylint.cfg mrg_core
To build the sphinx documentation,
cd ~/PycharmProjects/mrg_core/docs
make html
# ubuntu
firefox build/html/index.html
# windows
start build/html/index.html
Usage
This packages contains many runnable scripts. These are listed below,
TODO
Documentation
The documentation can be found at this link: https://mrg-tools.gitlab.io/mrg_core/
License
ESA Software Community License - Type 3. See License File.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for mrg_core-0.1.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bf77b0309c3485e3c7abbb9e92b64a5a0006513eeb5a52563d051e4fbbb80b3a |
|
MD5 | 5c1e539e4e672e4b7c7710c2408d3e67 |
|
BLAKE2b-256 | a47a438655d907bcee7a69a311fb693671255e026410344d0c308f9e6bcc15b2 |