diff --git a/package.rst b/package.rst new file mode 100644 index 0000000..e58d6c5 --- /dev/null +++ b/package.rst @@ -0,0 +1,60 @@ +Plate Simulation +================ + +**Plate Simulation** is a package for creating a specialized mesh, model and simulation for +a particular parameterization of tabular bodies in a layered geological setting. + + +Installation +^^^^^^^^^^^^ +**Plate Simulation** is currently written for Python 3.10 or higher. + +Install **plate-simulation** from PyPI:: + + $ pip install plate-simulation + + +Feedback +^^^^^^^^ +Have comments or suggestions? Submit feedback through `Mira Geoscience Support portal `_. + +Visit `Mira Geoscience website `_ to learn more about our products +and services. + + +License +^^^^^^^ +MIT License + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. + +Third Party Software +^^^^^^^^^^^^^^^^^^^^ +The plate-simulation Software may provide links to third party libraries or code (collectively “Third Party Software”) +to implement various functions. Third Party Software does not comprise part of the Software. +The use of Third Party Software is governed by the terms of such software license(s). +Third Party Software notices and/or additional terms and conditions are located in the +`THIRD_PARTY_SOFTWARE.rst`_ file. + +.. _THIRD_PARTY_SOFTWARE.rst: docs/THIRD_PARTY_SOFTWARE.rst + + +Copyright +^^^^^^^^^ +Copyright (c) 2024-2025 Mira Geoscience Ltd. diff --git a/pyproject.toml b/pyproject.toml index 89133ac..c7809fe 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -8,7 +8,7 @@ description = """ the halfspace + overburden and plate geological setting""" authors = ["Mira Geoscience "] -readme = "README.rst" +readme = "package.rst" repository = "https://github.com/MiraGeoscience/plate-simulation" maintainers = [ "Benjamin Kary ",