Metadata-Version: 2.1
Name: drillcore-transformations
Version: 0.2.6
Summary: Transform structural drillcore measurements.
Home-page: https://github.com/nialov/drillcore-transformations
License: MIT
Keywords: data
Author: nialov
Author-email: nikolasovaskainen@gmail.com
Requires-Python: >=3.7.1,<4.0.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Scientific/Engineering :: GIS
Provides-Extra: coverage
Provides-Extra: docs
Provides-Extra: format-lint
Provides-Extra: typecheck
Requires-Dist: black[jupyter]; extra == "format-lint"
Requires-Dist: blackdoc; extra == "format-lint"
Requires-Dist: blacken-docs; extra == "format-lint"
Requires-Dist: click
Requires-Dist: coverage (>=5.0,<6.0); extra == "coverage"
Requires-Dist: coverage-badge; extra == "coverage"
Requires-Dist: isort; extra == "format-lint"
Requires-Dist: matplotlib
Requires-Dist: mypy; extra == "typecheck"
Requires-Dist: nbsphinx; extra == "docs"
Requires-Dist: numpy
Requires-Dist: openpyxl
Requires-Dist: pandas
Requires-Dist: pylint; extra == "format-lint"
Requires-Dist: rstcheck; extra == "format-lint"
Requires-Dist: sphinx-autobuild
Requires-Dist: sphinx-autodoc-typehints; extra == "docs"
Requires-Dist: sphinx-gallery; extra == "docs"
Requires-Dist: sphinx-rtd-theme; extra == "docs"
Requires-Dist: sphinx; extra == "docs" or extra == "format-lint"
Requires-Dist: xlrd
Project-URL: Documentation, https://drillcore-transformations.readthedocs.io/en/latest/
Project-URL: Repository, https://github.com/nialov/drillcore-transformations
Description-Content-Type: text/x-rst

Drillcore Transformations
=========================

|Documentation Status| |PyPI Status| |CI Test| |Coverage|

Features
--------

-  Transforms measurements from drillcores.
-  Supports alpha, beta and gamma measurements.
-  Supports .csv and .xlsx files.
-  Supports adding the column names of your data files to a custom-built
   config.ini file for each user.
-  TODO: Convention support
-  Currently supported convention explanation found in `Documentation
   and Help <https://drillcore-transformations.readthedocs.io>`__
-  **Documentation and Help**:
   https://drillcore-transformations.readthedocs.io.

Running tests
-------------

To run pytest in currently installed environment:

.. code:: bash

   poetry run pytest

To run full extensive test suite:

.. code:: bash

   poetry run invoke test

Formatting and linting
----------------------

Formatting and linting is done with a single command. First formats,
then lints.

.. code:: bash

   poetry run invoke format-and-lint

Building docs
-------------

Docs can be built locally to test that ``ReadTheDocs`` can also build
them:

.. code:: bash

   poetry run invoke docs

Invoke usage
------------

To list all available commands from ``tasks.py``:

.. code:: bash

   poetry run invoke --list

Development
~~~~~~~~~~~

Development dependencies include:

   -  invoke
   -  nox
   -  copier
   -  pytest
   -  coverage
   -  sphinx

Big thanks to all maintainers of the above packages!

Credits
-------

-  PhD Jussi Mattila for tips, code snippets and sample materials.
-  Authors of `Orientation uncertainty goes
   bananas <https://tinyurl.com/tqr84ww>`__ for great article and
   complementary excel-file.

License
~~~~~~~

Copyright © 2020, Nikolas Ovaskainen.

-----


.. |Documentation Status| image:: https://readthedocs.org/projects/drillcore-transformations/badge/?version=latest
   :target: https://drillcore-transformations.readthedocs.io/en/latest/?badge=latest
.. |PyPI Status| image:: https://img.shields.io/pypi/v/drillcore-transformations.svg
   :target: https://pypi.python.org/pypi/drillcore-transformations
.. |CI Test| image:: https://github.com/nialov/drillcore-transformations/workflows/test-and-publish/badge.svg
   :target: https://github.com/nialov/drillcore-transformations/actions/workflows/test-and-publish.yaml?query=branch%3Amaster
.. |Coverage| image:: https://raw.githubusercontent.com/nialov/drillcore-transformations/master/docs_src/imgs/coverage.svg
   :target: https://github.com/nialov/drillcore-transformations/blob/master/docs_src/imgs/coverage.svg

