Metadata-Version: 2.4
Name: regolith
Version: 0.10.0rc1
Summary: Python package for research group content management system
Author-email: "Simon J.L. Billinge group" <sbillinge@ucsb.edu>, Anthony Scopatz <scopatz@gmail.com>
Maintainer-email: Simon Billinge <sbillinge@ucsb.edu>, Anthony Scopatz <scopatz@gmail.com>
Project-URL: Homepage, https://github.com/regro/regolith/
Project-URL: Issues, https://github.com/regro/regolith/issues/
Keywords: content management system
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: CC0 1.0 Universal (CC0 1.0) Public Domain Dedication
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Scientific/Engineering :: Chemistry
Requires-Python: <3.15,>=3.12
Description-Content-Type: text/x-rst
License-File: LICENSE.rst
License-File: AUTHORS.rst
Requires-Dist: ruamel.yaml
Requires-Dist: bibtexparser
Requires-Dist: docutils
Requires-Dist: jinja2
Requires-Dist: cerberus
Requires-Dist: flatten-dict
Requires-Dist: xonsh
Requires-Dist: rever
Requires-Dist: openpyxl
Requires-Dist: nameparser
Requires-Dist: pandas
Requires-Dist: pymongo
Requires-Dist: matplotlib
Requires-Dist: habanero
Requires-Dist: google-api-python-client
Requires-Dist: google-auth-oauthlib
Requires-Dist: wxpython
Requires-Dist: gooey
Dynamic: license-file

|Icon| |title|_
===============

.. |title| replace:: regolith
.. _title: https://regro.github.io/regolith

.. |Icon| image:: https://avatars.githubusercontent.com/regro
        :target: https://regro.github.io/regolith
        :height: 100px

|PyPI| |Forge| |PythonVersion| |PR|

|CI| |Codecov| |Black| |Tracking|

.. |Black| image:: https://img.shields.io/badge/code_style-black-black
        :target: https://github.com/psf/black

.. |CI| image:: https://github.com/regro/regolith/actions/workflows/matrix-and-codecov-on-merge-to-main.yml/badge.svg
        :target: https://github.com/regro/regolith/actions/workflows/matrix-and-codecov-on-merge-to-main.yml

.. |Codecov| image:: https://codecov.io/gh/regro/regolith/branch/main/graph/badge.svg
        :target: https://codecov.io/gh/regro/regolith

.. |Forge| image:: https://img.shields.io/conda/vn/conda-forge/regolith
        :target: https://anaconda.org/conda-forge/regolith

.. |PR| image:: https://img.shields.io/badge/PR-Welcome-29ab47ff

.. |PyPI| image:: https://img.shields.io/pypi/v/regolith
        :target: https://pypi.org/project/regolith/

.. |PythonVersion| image:: https://img.shields.io/pypi/pyversions/regolith
        :target: https://pypi.org/project/regolith/

.. |Tracking| image:: https://img.shields.io/badge/issue_tracking-github-blue
        :target: https://github.com/regro/regolith/issues

Python package for research group content management system

Regolith is a content management system for software & research groups. Regolith creates and manages a database of people, publications, projects, proposals & grants, courses, and more! From this database, regolith is then able to:

* Generate a group website,
* Generate CVs and publication lists for the group members,
* Act as a grade book for your courses, and more!

The databases may be file-based (JSON and YAML) or MongoDB-based.

For more information about the regolith library, please consult our `online documentation <https://regro.github.io/regolith>`__.

Citation
--------

If you use regolith in a scientific publication, we would like you to cite this package as

        regolith Package, https://github.com/regro/regolith

Installation
------------

The preferred method is to use `Miniconda Python
<https://docs.conda.io/projects/miniconda/en/latest/miniconda-install.html>`_
and install from the "conda-forge" channel of Conda packages.

To add "conda-forge" to the conda channels, run the following in a terminal. ::

        conda config --add channels conda-forge

We want to install our packages in a suitable conda environment.
The following creates and activates a new environment named ``regolith_env`` ::

        conda create -n regolith-env regolith
        conda activate regolith-env

The output should print the latest version displayed on the badges above.

If the above does not work, you can use ``pip`` to download and install the latest release from
`Python Package Index <https://pypi.python.org>`_.
To install using ``pip`` into your ``regolith_env`` environment, type ::

        pip install regolith

If you prefer to install from sources, after installing the dependencies, obtain the source archive from
`GitHub <https://github.com/regro/regolith/>`_. Once installed, ``cd`` into your ``regolith`` directory
and run the following ::

        pip install .

This package also provides command-line utilities. To check the software has been installed correctly, type ::

        regolith --version

You can also type the following command to verify the installation. ::

        python -c "import regolith; print(regolith.__version__)"


To view the basic usage and available commands, type ::

        regolith -h

Getting Started
---------------

You may consult our `online documentation <https://regro.github.io/regolith>`_ for tutorials and API references.

Support and Contribute
----------------------

`Diffpy user group <https://groups.google.com/g/diffpy-users>`_ is the discussion forum for general questions and discussions about the use of regolith. Please join the regolith users community by joining the Google group. The regolith project welcomes your expertise and enthusiasm!

If you see a bug or want to request a feature, please `report it as an issue <https://github.com/regro/regolith/issues>`_ and/or `submit a fix as a PR <https://github.com/regro/regolith/pulls>`_. You can also post it to the `Diffpy user group <https://groups.google.com/g/diffpy-users>`_.

Feel free to fork the project and contribute. To install regolith
in a development mode, with its sources being directly used by Python
rather than copied to a package directory, use the following in the root
directory ::

        pip install -e .

To ensure code quality and to prevent accidental commits into the default branch, please set up the use of our pre-commit
hooks.

1. Install pre-commit in your working environment by running ``conda install pre-commit``.

2. Initialize pre-commit (one time only) ``pre-commit install``.

Thereafter your code will be linted by black and isort and checked against flake8 before you can commit.
If it fails by black or isort, just rerun and it should pass (black and isort will modify the files so should
pass after they are modified). If the flake8 test fails please see the error messages and fix them manually before
trying to commit again.

Improvements and fixes are always appreciated.

Before contributing, please read our `Code of Conduct <https://github.com/regro/regolith/blob/main/CODE-OF-CONDUCT.rst>`_.

Contact
-------

For more information on regolith please visit the project `web-page <https://regro.github.io/>`_ or email the maintainers ``Simon Billinge(sbillinge@ucsb.edu)``.

Acknowledgements
----------------

``regolith`` is built and maintained with `scikit-package <https://scikit-package.github.io/scikit-package/>`_.
