# Midgard, the Python Geodesy library
Midgard is a collection of useful Python utilities used by the Geodetic
institute at the Norwegian Mapping Authority (Kartverket). Although some of
these are geodesy-specific, many are also useful in more general settings.
**Note:** Midgard is still in pre-alpha status. Its functionality will change,
and it should not be depended on in any production-like setting.
[](https://pypi.org/project/midgard/)
[](https://pypi.org/project/midgard/)
[](https://github.com/ambv/black)
## Installing Midgard
Midgard is available at [PyPI](https://pypi.org/project/midgard/). You can
install it by simply running
python -m pip install midgard
## Installing Midgard from source
Midgard depends on several other brilliant Python packages, like for instance
numpy, scipy, etc. We recommend using the Anaconda distribution to ease
the installation of these dependencies.
### Install Anaconda
Go to [www.anaconda.com/download](https://www.anaconda.com/download), and
download Anaconda for Python 3.
### Download the Midgard source code
If you have not already done so, download the Midgard source code from Github:
[github.com/kartverket/midgard](https://github.com/kartverket/midgard). Then
enter the main `midgard` directory before running the install command below.
cd midgard
### Install dependencies
You should now install the necessary dependencies using the
`environment.yml`-file. You can do this either in your current conda
environment, or choose to create a new `midgard`-environment. In order to use
`midgard` in other projects you need to install `midgard` in the same
environment as those projects.
To install `midgard` in your current environment, do
conda env update -f environment.yml
To install `midgard` in a new environment named `midgard` and activate it, do
conda env create -n midgard -f environment.yml
conda activate midgard
### Install the Midgard package
To do the actual installation of Midgard, use the `flit` packaging tool:
python -m flit install --dep production
If you want to develop the Midgard package, install it in editable mode using
python -m flit install -s
On Windows, you can install in editable mode using
python -m flit install --pth-file
## Using Midgard
Midgard comes organized into different subpackages. To see info about the
different subpackages, use the Python help system:
>>> import midgard
>>> help(midgard)
Information about individual subpackages is also available on the
[Midgard website](https://kartverket.github.io/midgard/).
Raw data
{
"_id": null,
"home_page": "https://github.com/kartverket/midgard",
"name": "midgard",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "geodesy utilities",
"author": "Norwegian Mapping Authority",
"author_email": "geir.arne.hjelle@kartverket.no",
"download_url": "https://files.pythonhosted.org/packages/99/63/5254c4f66bffbe42e9c307d8b2662e0245e2b8b8ab6d1ba9a94aaaa73fb1/midgard-1.3.0.tar.gz",
"platform": null,
"description": "# Midgard, the Python Geodesy library\n\nMidgard is a collection of useful Python utilities used by the Geodetic\ninstitute at the Norwegian Mapping Authority (Kartverket). Although some of\nthese are geodesy-specific, many are also useful in more general settings.\n\n**Note:** Midgard is still in pre-alpha status. Its functionality will change,\n and it should not be depended on in any production-like setting.\n\n[](https://pypi.org/project/midgard/)\n[](https://pypi.org/project/midgard/)\n[](https://github.com/ambv/black)\n\n\n## Installing Midgard\n\nMidgard is available at [PyPI](https://pypi.org/project/midgard/). You can\ninstall it by simply running\n\n python -m pip install midgard\n\n\n## Installing Midgard from source\n\nMidgard depends on several other brilliant Python packages, like for instance\nnumpy, scipy, etc. We recommend using the Anaconda distribution to ease\nthe installation of these dependencies.\n\n### Install Anaconda\n\nGo to [www.anaconda.com/download](https://www.anaconda.com/download), and\ndownload Anaconda for Python 3.\n\n\n### Download the Midgard source code\n\nIf you have not already done so, download the Midgard source code from Github:\n[github.com/kartverket/midgard](https://github.com/kartverket/midgard). Then\nenter the main `midgard` directory before running the install command below.\n\n cd midgard\n\n\n### Install dependencies\n\nYou should now install the necessary dependencies using the\n`environment.yml`-file. You can do this either in your current conda\nenvironment, or choose to create a new `midgard`-environment. In order to use\n`midgard` in other projects you need to install `midgard` in the same\nenvironment as those projects.\n\nTo install `midgard` in your current environment, do\n\n conda env update -f environment.yml\n\nTo install `midgard` in a new environment named `midgard` and activate it, do\n\n conda env create -n midgard -f environment.yml\n conda activate midgard\n\n\n### Install the Midgard package\n\nTo do the actual installation of Midgard, use the `flit` packaging tool:\n\n python -m flit install --dep production\n\nIf you want to develop the Midgard package, install it in editable mode using\n\n python -m flit install -s\n\nOn Windows, you can install in editable mode using\n\n python -m flit install --pth-file\n\n\n## Using Midgard\n\nMidgard comes organized into different subpackages. To see info about the\ndifferent subpackages, use the Python help system:\n\n >>> import midgard\n >>> help(midgard)\n\nInformation about individual subpackages is also available on the\n[Midgard website](https://kartverket.github.io/midgard/).\n",
"bugtrack_url": null,
"license": null,
"summary": "Midgard, the Python Geodesy library",
"version": "1.3.0",
"project_urls": {
"Homepage": "https://github.com/kartverket/midgard"
},
"split_keywords": [
"geodesy",
"utilities"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "a5e5a38b3dc3b91d92d274351938b54854afe415053365767f9fca1ae4313f7a",
"md5": "db96e1f53644fd39872e63de0a4fbe81",
"sha256": "6c60499a23de446fcadd0b89b3b3cfb004d102390d7173fb40afb46dc1137a53"
},
"downloads": -1,
"filename": "midgard-1.3.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "db96e1f53644fd39872e63de0a4fbe81",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 390328,
"upload_time": "2023-12-01T08:31:34",
"upload_time_iso_8601": "2023-12-01T08:31:34.417897Z",
"url": "https://files.pythonhosted.org/packages/a5/e5/a38b3dc3b91d92d274351938b54854afe415053365767f9fca1ae4313f7a/midgard-1.3.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "99635254c4f66bffbe42e9c307d8b2662e0245e2b8b8ab6d1ba9a94aaaa73fb1",
"md5": "d98e080c35aad1874ffccd5529fc2b09",
"sha256": "eec5fe91edcd68990891db90eca4deef87ea2282907a84dc3056189ccc458834"
},
"downloads": -1,
"filename": "midgard-1.3.0.tar.gz",
"has_sig": false,
"md5_digest": "d98e080c35aad1874ffccd5529fc2b09",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 1880023,
"upload_time": "2023-12-01T08:31:45",
"upload_time_iso_8601": "2023-12-01T08:31:45.261596Z",
"url": "https://files.pythonhosted.org/packages/99/63/5254c4f66bffbe42e9c307d8b2662e0245e2b8b8ab6d1ba9a94aaaa73fb1/midgard-1.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-01 08:31:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kartverket",
"github_project": "midgard",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "midgard"
}
JSON
