Library to handle reading, analysing and ploting GPS and other data
Project description
GPSlibrary
GPSlibrary is a Python package for plotting and analyzing GPS and other data. This package also includes comprehensive documentation for users and developers.
Table of Contents
Installation
To install GPSlibrary from the Vedur GitLab package registry, run:
pip install gpslibrary --index-url https://git.vedur.is/api/v4/projects/448/packages/pypi/simple
To install from the pypi package registry, run:
pip install gpslibrary
Local Development
To set up a local development environment for GPSlibrary:
- Clone the repository from Vedur GitLab:
git clone https://git.vedur.is/aut/gpslibrary.git
- Navigate to the project directory:
cd gpslibrary
- Create and activate a virtual environment:
python -m venv env source env/bin/activate
- Install the development dependencies:
pip install -r requirements-dev.txt
- Install the package in editable mode:
pip install -e .
Running the Documentation Locally
To build and serve the GPSlibrary documentation locally:
- Install MkDocs and required plugins:
pip install mkdocs mkdocs-material mkdocstrings-python
- Serve the documentation on a local server:
mkdocs serve
- Open a browser to
http://127.0.0.1:8000
to view the documentation.
Contributing
We welcome contributions to the GPSlibrary project! Please refer to the authors for guidelines on how to make contributions.
License
GPSlibrary is released under the MIT License. See the LICENSE file for more details.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for gpslibrary-0.2.17-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 86b23e6bc6bdbcd7bea89b575a6b23f200e96f5fa3ad4297cfa291ca2d83d8cf |
|
MD5 | c90a616e13a6792e809f97f4307f344e |
|
BLAKE2b-256 | 48f5421e6da7243025165f534039ae0be973b1c1cd15f0ef2b68546e2524ddda |