comet_maths
===========
Mathematical algorithms and tools to use within CoMet toolkit.
Usage
=====
Virtual environment
-------------------
It's always recommended to make a virtual environment for each of your python
projects. Use your preferred virtual environment manager if you want and
activate it for the rest of these commands.
If you are using conda you can create and activate your environment using::
conda create -n yourenvname -k python=3.x
followed by::
conda activate yourenvname (activate environment in windows)
or::
source activate yourenvname (activate environment on a UNIX operating system)
You can also use venv. If you're unfamiliar, read
https://realpython.com/python-virtual-environments-a-primer/. You can set one up
using::
python -m venv venv
and then activate it on Windows by using ``venv/Scripts/activate``.
Installation
------------
Install your package and its dependancies by using::
pip install -e .
Development
-----------
For developing the package, you'll want to install the pre-commit hooks as well. Type::
pre-commit install
Note that from now on when you commit, `black` will check your code for styling
errors. If it finds any it will correct them, but the commit will be aborted.
This is so that you can check its work before you continue. If you're happy,
just commit again.
Running the test suite is possible by running `pytest`.
Compatibility
-------------
Licence
-------
Authors
-------
`comet_maths` was written by `Pieter De Vis <pieter.de.vis@npl.co.uk>`_.
Raw data
{
"_id": null,
"home_page": "https://github.com/comet-toolkit/comet_maths",
"name": "comet-maths",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "CoMet Toolkit Team",
"author_email": "team@comet-toolkit.org",
"download_url": "https://files.pythonhosted.org/packages/7f/bb/ac8993e57622a94bab8f439789a84c93885e99958f4ddaa971ffd6b90d78/comet_maths-1.0.0.tar.gz",
"platform": null,
"description": "comet_maths\r\n===========\r\n\r\nMathematical algorithms and tools to use within CoMet toolkit.\r\n\r\nUsage\r\n=====\r\n\r\nVirtual environment\r\n-------------------\r\n\r\nIt's always recommended to make a virtual environment for each of your python\r\nprojects. Use your preferred virtual environment manager if you want and\r\nactivate it for the rest of these commands.\r\n\r\nIf you are using conda you can create and activate your environment using::\r\n\r\n conda create -n yourenvname -k python=3.x\r\n\r\nfollowed by::\r\n\r\n conda activate yourenvname (activate environment in windows)\r\n\r\nor::\r\n\r\n source activate yourenvname (activate environment on a UNIX operating system)\r\n\r\nYou can also use venv. If you're unfamiliar, read\r\nhttps://realpython.com/python-virtual-environments-a-primer/. You can set one up\r\nusing::\r\n\r\n python -m venv venv\r\n\r\nand then activate it on Windows by using ``venv/Scripts/activate``. \r\n\r\nInstallation\r\n------------\r\n\r\nInstall your package and its dependancies by using::\r\n\r\n pip install -e .\r\n\r\nDevelopment\r\n-----------\r\n\r\nFor developing the package, you'll want to install the pre-commit hooks as well. Type::\r\n\r\n pre-commit install\r\n\r\n\r\nNote that from now on when you commit, `black` will check your code for styling\r\nerrors. If it finds any it will correct them, but the commit will be aborted.\r\nThis is so that you can check its work before you continue. If you're happy,\r\njust commit again. \r\n\r\nRunning the test suite is possible by running `pytest`.\r\n\r\nCompatibility\r\n-------------\r\n\r\nLicence\r\n-------\r\n\r\nAuthors\r\n-------\r\n\r\n`comet_maths` was written by `Pieter De Vis <pieter.de.vis@npl.co.uk>`_.\r\n",
"bugtrack_url": null,
"license": "LGPLv3",
"summary": "Mathematical algorithms and tools to use within CoMet toolkit.",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/comet-toolkit/comet_maths"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "47b8eb81b61104def592389e0c54b12dc7eb75c9ab599a5b96b040390e600e91",
"md5": "801cfa930de33eb4982f100231f84f01",
"sha256": "597165e71d54e0de678372763373470954feeb1a88926fbb41eac163883b7b8d"
},
"downloads": -1,
"filename": "comet_maths-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "801cfa930de33eb4982f100231f84f01",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 33368,
"upload_time": "2024-04-02T23:06:39",
"upload_time_iso_8601": "2024-04-02T23:06:39.373122Z",
"url": "https://files.pythonhosted.org/packages/47/b8/eb81b61104def592389e0c54b12dc7eb75c9ab599a5b96b040390e600e91/comet_maths-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7fbbac8993e57622a94bab8f439789a84c93885e99958f4ddaa971ffd6b90d78",
"md5": "dd32d9f0eb28c32d1c467096a20260fa",
"sha256": "a5f6f71d87a0a23e5e84df8e5f21663d84707b633b890383601691acd760f623"
},
"downloads": -1,
"filename": "comet_maths-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "dd32d9f0eb28c32d1c467096a20260fa",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 46050,
"upload_time": "2024-04-02T23:06:40",
"upload_time_iso_8601": "2024-04-02T23:06:40.896607Z",
"url": "https://files.pythonhosted.org/packages/7f/bb/ac8993e57622a94bab8f439789a84c93885e99958f4ddaa971ffd6b90d78/comet_maths-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-02 23:06:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "comet-toolkit",
"github_project": "comet_maths",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "comet-maths"
}
JSON
