Skip to main content

Handling of units related to simple climate modelling.

Project description

OpenSCM-Units

Handling of units related to simple climate modelling.

Key info : Docs Main branch: supported Python versions Licence

PyPI : PyPI PyPI install

Conda : Conda Conda platforms Conda install

Tests : CI Coverage

Other info : Last Commit Contributors

Status

  • development: the project is actively being worked on

Full documentation can be found at: openscm-units.readthedocs.io. We recommend reading the docs there because the internal documentation links don't render correctly on GitHub's viewer.

Installation

As a library

If you want to use OpenSCM-Units as a library, for example you want to use it as a dependency in another package/application that you're building, then we recommend installing the package with the commands below. This method provides the loosest pins possible of all dependencies. This gives you, the package/application developer, as much freedom as possible to set the versions of different packages. However, the tradeoff with this freedom is that you may install incompatible versions of OpenSCM-Units's dependencies (we cannot test all combinations of dependencies, particularly ones which haven't been released yet!). Hence, you may run into installation issues. If you believe these are because of a problem in OpenSCM-Units, please raise an issue.

The (non-locked) version of OpenSCM-Units can be installed with

=== "pip" sh pip install openscm-units

=== "mamba" sh mamba install -c conda-forge openscm-units

=== "conda" sh conda install -c conda-forge openscm-units

As an application

If you want to use OpenSCM-Units as an application, then we recommend using the 'locked' version of the package. This version pins the version of all dependencies too, which reduces the chance of installation issues because of breaking updates to dependencies.

The locked version of OpenSCM-Units can be installed with

=== "pip" sh pip install openscm-units[locked]

=== "mamba" sh mamba install -c conda-forge openscm-units-locked

=== "conda" sh conda install -c conda-forge openscm-units-locked

For developers

For development, we rely on pdm for all our dependency management. To get started, you will need to make sure that pdm is installed (instructions here, although we found that installing with pipx worked perfectly for us).

For all of our work, we use our Makefile. You can read the instructions out and run the commands by hand if you wish, but we generally discourage this because it can be error prone. In order to create your environment, run make virtual-environment.

If there are any issues, the messages from the Makefile should guide you through. If not, please raise an issue in the issue tracker.

For the rest of our developer docs, please see [development][development].

Original template

This project was generated from this template: copier core python repository. copier is used to manage and distribute this template.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

openscm_units-0.6.3.tar.gz (19.5 kB view details)

Uploaded Source

Built Distribution

openscm_units-0.6.3-py3-none-any.whl (14.3 kB view details)

Uploaded Python 3

File details

Details for the file openscm_units-0.6.3.tar.gz.

File metadata

  • Download URL: openscm_units-0.6.3.tar.gz
  • Upload date:
  • Size: 19.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: pdm/2.19.2 CPython/3.10.12 Linux/6.5.0-1025-azure

File hashes

Hashes for openscm_units-0.6.3.tar.gz
Algorithm Hash digest
SHA256 36f4e62b7622498df82895fbb89a63e19e2e686a74ad28e0679dd8f46d3c59b9
MD5 62a174e158586089e37c2c3d7689886f
BLAKE2b-256 64945adeb33bad2b6529f6535a29c95b62b39aacaa8164661da6d85871145df0

See more details on using hashes here.

Provenance

File details

Details for the file openscm_units-0.6.3-py3-none-any.whl.

File metadata

  • Download URL: openscm_units-0.6.3-py3-none-any.whl
  • Upload date:
  • Size: 14.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: pdm/2.19.2 CPython/3.10.12 Linux/6.5.0-1025-azure

File hashes

Hashes for openscm_units-0.6.3-py3-none-any.whl
Algorithm Hash digest
SHA256 3837e2d6fe2f641e63c731787fcaad8e6e3baabb62d673f2903bfcc863e8fce8
MD5 2e13b4accf252608f8198576810cfa90
BLAKE2b-256 b29ff48e406b4f92741f50350abeb054ed960bb2b1265bd4d21c3eb4906600c9

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page