| Name | lamatrix JSON |
| Version |
1.0.0
JSON |
| download |
| home_page | None |
| Summary | None |
| upload_time | 2025-02-25 20:12:27 |
| maintainer | None |
| docs_url | None |
| author | Christina Hedges |
| requires_python | <4.0,>=3.9 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
########
lamatrix
########
.. image:: https://github.com/pandoramission/lamatrix/actions/workflows/pytest.yml/badge.svg
:target: https://github.com/pandoramission/lamatrix/actions/workflows/pytest.yml
:alt: Test status
.. image:: https://badge.fury.io/py/lamatrix.svg
:target: https://badge.fury.io/py/lamatrix
:alt: PyPI version
.. image:: https://img.shields.io/badge/documentation-live-blue.svg
:target: https://pandoramission.github.io/lamatrix/
:alt: Documentation
.. <!-- intro content start -->
The ``lamatrix`` package is designed to help you build linear algebra models in Python to help you fit simple models to data. ``lamatrix`` will do all the fitting and shaping inside the package, so you can put in objects of any shape and fit ND models easily.
.. <!-- intro content end -->
.. <!-- quickstart content start -->
Quickstart
==========
The easiest way to install ``lamatrix`` and all of its dependencies is to use the ``pip`` command.
To install ``lamatrix``, run the following command in a terminal window:
.. code-block:: console
$ python -m pip install lamatrix --upgrade
The ``--upgrade`` flag is optional, but recommended if you already
have ``lamatrix`` installed and want to upgrade to the latest version.
Depending on the specific Python environment, you may need to replace ``python``
with the correct Python interpreter, e.g., ``python3``.
If you are trying to develop functionality to ``lamatrix`` you can install using github and poetry. Make sure you install the development dependencies
.. code-block:: console
$ git clone https://github.com/PandoraMission/lamatrix
$ cd lamatrix
$ poetry install --with dev
You can then add functionality and run tests using
.. code-block:: console
$ cd lamatrix
$ make
If you install in this way you will need to use poetry to use the code. Check out the `poetry documentation`_ for more information on how to use poetry.
Now you have the package installed, you should check out the tutorials to see how to build a model with ``lamatrix`` and fit data.
.. _`poetry documentation`: https://python-poetry.org/docs/
.. <!-- quickstart content end -->
.. <!-- Contributing content start -->
Contributing
============
``lamatrix`` is an open-source package. Users are welcome to contribute and develop new features for ``lamatrix``, or add new documentation.
To work on ``lamatrix`` and add new functionality you can follow these steps.
0. Fork the project
-------------------
You should for the ``lamatrix`` github repo to your own account so that you can open pull requests against the main repository.
1. Installing the package
-------------------------
If you are trying to develop functionality to ``lamatrix`` you can install using github and poetry. Make sure you install the development dependencies
.. code-block:: console
$ git clone https://github.com/PandoraMission/lamatrix
$ cd lamatrix
$ poetry install --with dev
This has now created a new poetry enviroment and installed the dependencies, development dependencies, and the package itself.
2. Updating the package
-----------------------
You can now add any updates to the package you would like. The first step is to create and name a new branch.
.. code-block:: console
$ git checkout -b BRANCHNAME
If you have not used your branch in a while, make sure you pull and merge any updates on the main branch.
.. code-block:: console
$ git pull origin main
You will have to resolve any merge conflicts.
Once you have update the package, you should ensure you have done the following
* Updated the version number in the pyproject.toml file. If this is a bug fix, update the patch number. If it is adding new functionality but otherwise not changing the API update the minor number. If it is a change to the API entirely, update the major version number.
* Update the CHANGELOG in this readme file.
* Ensure your functionality has updated documentation. This means both adding docstrings, and adding to the API documentation in the ``docs/`` directory.
* Ensure your new functionality is covered by new tests. If you add any functionality, add tests in the ``tests/`` directory.
3. Running tests
----------------
To run tests you can go into the root directory for the package and use the ``Makefile``.
.. code-block:: console
$ make
This will run ``black``, ``isort``, ``flake8``, and ``pytest``. All of these should pass locally on your machine. Ensure the tests pass before moving to the next steps.
4. Building docs
----------------
The docs can be checked by running the following from within the ``docs/`` directory
.. code-block:: console
$ make serve
This will compile and serve the docs at ``http://127.0.0.1:8001``. This will recompile all the notebooks in the ``docs/`` directory. You should be able to stop the serve action by using ``ctrl+c`` in the terminal window. If you accidentally close the terminal window and that port is blocked you can use
.. code-block:: console
$ make stop-serve
to stop the docs on that port.
Once you have checked the docs look good you can move onto the next step.
5. Opening a Pull Request
-------------------------
You can now open a pull request against the main branch on the main repository. Once the PR is reviewed and found to enhance the package, it will be merged in by an administrator.
.. <!-- Contributing content end -->
.. <!-- Contact content start -->
Contact
=======
``lamatrix`` is an open source community package. The best way to notify a bug in the package is to `open an issue`_. Please include a self-contained example that fully demonstrates your problem or question.
.. _`open an issue`: https://github.com/pandoramission/lamatrix/issues/new
.. <!-- Contact content end -->
.. <!-- Changelog content start -->
Changelog:
==========
- Initial v1.0.0 release of `lamatrix`.
.. <!-- Changelog content end -->
Raw data
{
"_id": null,
"home_page": null,
"name": "lamatrix",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Christina Hedges",
"author_email": "christina.l.hedges@nasa.gov",
"download_url": "https://files.pythonhosted.org/packages/d7/25/04a3c59e984d00dba07c82afe22d7844b228425d105570b5e09b27cdd8f1/lamatrix-1.0.0.tar.gz",
"platform": null,
"description": "########\nlamatrix\n########\n\n\n.. image:: https://github.com/pandoramission/lamatrix/actions/workflows/pytest.yml/badge.svg\n :target: https://github.com/pandoramission/lamatrix/actions/workflows/pytest.yml\n :alt: Test status\n\n.. image:: https://badge.fury.io/py/lamatrix.svg\n :target: https://badge.fury.io/py/lamatrix\n :alt: PyPI version\n\n.. image:: https://img.shields.io/badge/documentation-live-blue.svg\n :target: https://pandoramission.github.io/lamatrix/\n :alt: Documentation\n\n.. <!-- intro content start -->\n\n\nThe ``lamatrix`` package is designed to help you build linear algebra models in Python to help you fit simple models to data. ``lamatrix`` will do all the fitting and shaping inside the package, so you can put in objects of any shape and fit ND models easily. \n\n\n.. <!-- intro content end -->\n\n.. <!-- quickstart content start -->\n\nQuickstart\n==========\n\nThe easiest way to install ``lamatrix`` and all of its dependencies is to use the ``pip`` command.\n\nTo install ``lamatrix``, run the following command in a terminal window:\n\n.. code-block:: console\n\n $ python -m pip install lamatrix --upgrade\n\nThe ``--upgrade`` flag is optional, but recommended if you already\nhave ``lamatrix`` installed and want to upgrade to the latest version.\n\nDepending on the specific Python environment, you may need to replace ``python``\nwith the correct Python interpreter, e.g., ``python3``.\n\nIf you are trying to develop functionality to ``lamatrix`` you can install using github and poetry. Make sure you install the development dependencies\n\n.. code-block:: console\n\n $ git clone https://github.com/PandoraMission/lamatrix\n $ cd lamatrix\n $ poetry install --with dev\n\nYou can then add functionality and run tests using\n\n.. code-block:: console\n\n $ cd lamatrix\n $ make\n\nIf you install in this way you will need to use poetry to use the code. Check out the `poetry documentation`_ for more information on how to use poetry.\n\nNow you have the package installed, you should check out the tutorials to see how to build a model with ``lamatrix`` and fit data. \n\n .. _`poetry documentation`: https://python-poetry.org/docs/\n\n.. <!-- quickstart content end -->\n\n.. <!-- Contributing content start -->\n\nContributing\n============\n\n``lamatrix`` is an open-source package. Users are welcome to contribute and develop new features for ``lamatrix``, or add new documentation.\n\nTo work on ``lamatrix`` and add new functionality you can follow these steps.\n\n0. Fork the project\n-------------------\n\nYou should for the ``lamatrix`` github repo to your own account so that you can open pull requests against the main repository.\n\n1. Installing the package\n-------------------------\n\nIf you are trying to develop functionality to ``lamatrix`` you can install using github and poetry. Make sure you install the development dependencies\n\n.. code-block:: console\n\n $ git clone https://github.com/PandoraMission/lamatrix\n $ cd lamatrix\n $ poetry install --with dev\n\nThis has now created a new poetry enviroment and installed the dependencies, development dependencies, and the package itself. \n\n2. Updating the package\n-----------------------\n\nYou can now add any updates to the package you would like. The first step is to create and name a new branch.\n\n.. code-block:: console\n\n $ git checkout -b BRANCHNAME\n\nIf you have not used your branch in a while, make sure you pull and merge any updates on the main branch.\n\n.. code-block:: console\n\n $ git pull origin main\n\nYou will have to resolve any merge conflicts.\n\nOnce you have update the package, you should ensure you have done the following\n\n* Updated the version number in the pyproject.toml file. If this is a bug fix, update the patch number. If it is adding new functionality but otherwise not changing the API update the minor number. If it is a change to the API entirely, update the major version number.\n* Update the CHANGELOG in this readme file. \n* Ensure your functionality has updated documentation. This means both adding docstrings, and adding to the API documentation in the ``docs/`` directory. \n* Ensure your new functionality is covered by new tests. If you add any functionality, add tests in the ``tests/`` directory. \n\n3. Running tests\n----------------\n\nTo run tests you can go into the root directory for the package and use the ``Makefile``.\n\n.. code-block:: console\n\n $ make\n\nThis will run ``black``, ``isort``, ``flake8``, and ``pytest``. All of these should pass locally on your machine. Ensure the tests pass before moving to the next steps.\n\n4. Building docs\n----------------\n\nThe docs can be checked by running the following from within the ``docs/`` directory\n\n.. code-block:: console\n\n $ make serve\n\nThis will compile and serve the docs at ``http://127.0.0.1:8001``. This will recompile all the notebooks in the ``docs/`` directory. You should be able to stop the serve action by using ``ctrl+c`` in the terminal window. If you accidentally close the terminal window and that port is blocked you can use\n\n.. code-block:: console\n\n $ make stop-serve\n\nto stop the docs on that port. \n\nOnce you have checked the docs look good you can move onto the next step.\n\n5. Opening a Pull Request\n-------------------------\n\nYou can now open a pull request against the main branch on the main repository. Once the PR is reviewed and found to enhance the package, it will be merged in by an administrator. \n\n.. <!-- Contributing content end -->\n\n.. <!-- Contact content start -->\n\nContact\n=======\n\n``lamatrix`` is an open source community package. The best way to notify a bug in the package is to `open an issue`_. Please include a self-contained example that fully demonstrates your problem or question.\n\n .. _`open an issue`: https://github.com/pandoramission/lamatrix/issues/new\n\n.. <!-- Contact content end -->\n\n.. <!-- Changelog content start -->\n\nChangelog:\n==========\n\n - Initial v1.0.0 release of `lamatrix`.\n \n.. <!-- Changelog content end -->",
"bugtrack_url": null,
"license": null,
"summary": null,
"version": "1.0.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6fc41d64af23424d555240923b80ae52cdfae05d2620a43c0485d0f888fa7fff",
"md5": "b58a247cd8584ebc03af62dc2c9c36e8",
"sha256": "53a7ca0ba767eb20b4014422259848cc5623932beba8dfa6ba78c7ade0c543d2"
},
"downloads": -1,
"filename": "lamatrix-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b58a247cd8584ebc03af62dc2c9c36e8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 32169,
"upload_time": "2025-02-25T20:12:25",
"upload_time_iso_8601": "2025-02-25T20:12:25.163835Z",
"url": "https://files.pythonhosted.org/packages/6f/c4/1d64af23424d555240923b80ae52cdfae05d2620a43c0485d0f888fa7fff/lamatrix-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d72504a3c59e984d00dba07c82afe22d7844b228425d105570b5e09b27cdd8f1",
"md5": "784bb01523cea6dff5812dd35d9a67c7",
"sha256": "16a7e0c16787e57ad2ffcc4e664fa085ae6ccd669ce796e86b389e9e88e06ba4"
},
"downloads": -1,
"filename": "lamatrix-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "784bb01523cea6dff5812dd35d9a67c7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 28171,
"upload_time": "2025-02-25T20:12:27",
"upload_time_iso_8601": "2025-02-25T20:12:27.003825Z",
"url": "https://files.pythonhosted.org/packages/d7/25/04a3c59e984d00dba07c82afe22d7844b228425d105570b5e09b27cdd8f1/lamatrix-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-25 20:12:27",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "lamatrix"
}
