more general doc updates

dirac-institute · Jan 28, 2025 · 4c9e085 · 4c9e085
1 parent aea1b0b
commit 4c9e085
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 5 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -17,8 +17,8 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
 project = "sorcha_addons"
-copyright = "2023, Meg Schwamb"
-author = "Meg Schwamb"
+copyright = "2025, Sorcha Team"
+author = "Sorcha Team"
 release = version("sorcha_addons")
 # for example take major/minor
 version = ".".join(release.split(".")[:2])

diff --git a/docs/contributing.rst b/docs/contributing.rst
@@ -1,3 +1,5 @@
+.. _contributing: 
+
 Contribution guide
 ==================
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -1,8 +1,26 @@
-Welcome to Sorcha's community utilities documentation!
+Welcome to Sorcha's Add-ons documentation!
 ======================================================
 
-Sorcha Community Utils is a collection of plugins for Sorcha that can be used to
-model changes to the magnitude of objects in the solar system simulation.
+``Sorcha Add-ons`` is a collection of plugins that can be used to
+model changes to the apparent magnitude (modeling effects of cometary activity or rotational light curve effects) for  objects simulated in the ``Sorcha``  Solar System simulator.
+
+``Sorcha`` (pronounced "surk-ha") is an open-source Solar System survey simulator written in Python. ``Sorcha`` means light or brightness in Irish and Scots Gaelic. Sorcha estimates the brightness of simulated Solar System small bodies and determines which ones the survey could detect in each of the survey's observations  based on user set criteria. ``Sorcha`` has been designed
+with the `Vera C. Rubin Observatory Legacy Survey of Space and Time (LSST) <https://rubinobservatory.org>`_
+in mind.  You can learn more about ``Sorcha`` `here <https://sorcha.readthedocs.io>`_. 
+
+
+.. note::
+   Contributions are very welcome. If you have a prescription for cometary activity or light curve effects for the ``Sorcha`` solar system survey simulator, we encourage you to  add your code to ``Sorcha add-ons``.  Further details can be found on our :ref:`contributing` page.
+
+.. seealso::
+   For a more detailed description of ``Sorcha`/``Sorcha add-ons`` and` and how it works, please see  `Merritt et al. (submitted) <https://www.dropbox.com/scl/fi/secetw7n0a936iynzxmau/sorcha_paper_2025_Jan_submission_version.pdf?rlkey=pbhchiattrw5bna8sfo6ljvto&dl=0>`_  and `Holman et al. (submitted) <https://www.dropbox.com/scl/fi/lz1lmua2s0yf9t9a2gpmm/sorcha_ephemeris_generation_paper.pdf?rlkey=blm9u4zbk0ci1i4lc5yqz8dbs&dl=0>`_.
+
+.. warning::
+   ``Sorcha`` is  currently under review. The code in the repository has been validated.
+   We will release ``Sorcha`` and ``Sorcha add-ons``  v1.0 on PyPI and conda-forge when accepted. We ask
+   that if you're external to the Sorcha team that you please wait to use ``Sorcha``/``Sorcha add-ons`` in your science papers until v1.0 of each are released.
+
+
 
 .. toctree::
    :hidden: