From 7cd6e3bb195177eaa4f48214e38971cecdec38bd Mon Sep 17 00:00:00 2001 From: Tristan Salles Date: Fri, 21 Jun 2024 09:08:20 +1000 Subject: [PATCH] modify index getting started --- docs/_static/Conda_logo.svg | 84 ----------------------- docs/_static/PyPI_logo.svg | 1 - docs/_static/Pythonlogo.svg | 17 ----- docs/_static/anaconda.svg | 2 + docs/_static/docker.svg | 7 +- docs/_static/pypi.svg | 4 ++ docs/_static/python.svg | 2 + docs/_static/version_switch.json | 4 +- docs/getting_started/index.rst | 111 ++++++++++++++++--------------- 9 files changed, 72 insertions(+), 160 deletions(-) delete mode 100644 docs/_static/Conda_logo.svg delete mode 100644 docs/_static/PyPI_logo.svg delete mode 100644 docs/_static/Pythonlogo.svg create mode 100644 docs/_static/anaconda.svg create mode 100644 docs/_static/pypi.svg create mode 100644 docs/_static/python.svg diff --git a/docs/_static/Conda_logo.svg b/docs/_static/Conda_logo.svg deleted file mode 100644 index be92cbc6..00000000 --- a/docs/_static/Conda_logo.svg +++ /dev/null @@ -1,84 +0,0 @@ - - - - logo_conda_RGB_inkscape - Created with Sketch. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/_static/PyPI_logo.svg b/docs/_static/PyPI_logo.svg deleted file mode 100644 index e53853c5..00000000 --- a/docs/_static/PyPI_logo.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/_static/Pythonlogo.svg b/docs/_static/Pythonlogo.svg deleted file mode 100644 index cfbb36f3..00000000 --- a/docs/_static/Pythonlogo.svg +++ /dev/null @@ -1,17 +0,0 @@ - - - - - - - - - - - - - - - - - diff --git a/docs/_static/anaconda.svg b/docs/_static/anaconda.svg new file mode 100644 index 00000000..c24b8f35 --- /dev/null +++ b/docs/_static/anaconda.svg @@ -0,0 +1,2 @@ + +Anaconda icon \ No newline at end of file diff --git a/docs/_static/docker.svg b/docs/_static/docker.svg index 42426899..c67299df 100644 --- a/docs/_static/docker.svg +++ b/docs/_static/docker.svg @@ -1 +1,6 @@ - \ No newline at end of file + + + +docker + + \ No newline at end of file diff --git a/docs/_static/pypi.svg b/docs/_static/pypi.svg new file mode 100644 index 00000000..858da17d --- /dev/null +++ b/docs/_static/pypi.svg @@ -0,0 +1,4 @@ + + + + \ No newline at end of file diff --git a/docs/_static/python.svg b/docs/_static/python.svg new file mode 100644 index 00000000..89191302 --- /dev/null +++ b/docs/_static/python.svg @@ -0,0 +1,2 @@ + + \ No newline at end of file diff --git a/docs/_static/version_switch.json b/docs/_static/version_switch.json index b0790ed5..97341a39 100644 --- a/docs/_static/version_switch.json +++ b/docs/_static/version_switch.json @@ -11,8 +11,8 @@ "url": "https://gospl.readthedocs.io" }, { - "name": "0.0.1 (stable)", - "version":"0.0.1-stable", + "name": "0.2.10 (stable)", + "version":"0.2.10-stable", "url": "https://gospl.readthedocs.io/en/stable/" } ] diff --git a/docs/getting_started/index.rst b/docs/getting_started/index.rst index 5f943137..f8f4324f 100644 --- a/docs/getting_started/index.rst +++ b/docs/getting_started/index.rst @@ -8,85 +8,86 @@ Getting started Python version support ---------------------- -Officially Python 3.7.1 and above, 3.8, and 3.9. +goSPL supports versions :mod:`3.3` to :mod:`3.12` of Python. Installation instructions ------------------------- -The easiest way to start using :mod:`gospl` is to install it as part of the -`Docker `__ distribution, a cross platform -distribution for data analysis and scientific computing. This is the recommended -installation method for most users. +The easiest way to start using goSPL is to install it from its Docker image, a cross platform distribution for data analysis and scientific computing. This is the recommended installation method for most users. -Instructions for installing from PyPI, Anaconda, or source are also provided. +Instructions for installing it via Anaconda or from source are also provided. -.. raw:: html +.. grid:: 1 1 2 2 + :gutter: 2 3 4 4 -
-
-
-
- Docker logo -
-

Lightweight virtualisation with Docker container provides a simple approach for running gospl model.

+ .. grid-item-card:: + :img-top: ../_static/docker.svg + :text-align: center -.. container:: custom-button + **Docker image** + ^^^ - :ref:`Learn more ` + Lightweight virtualisation with `Docker container `_ provides a simple approach for running goSPL simulation. -.. raw:: html + +++ -
-
-
-
-
- Conda logo -
-

For Anaconda users, an environment with specific collection of conda packages and gospl dependencies is available.

+ .. button-ref:: installDocker + :color: secondary + :click-parent: -.. container:: custom-button + Learn more - :ref:`Learn more ` + .. grid-item-card:: + :img-top: ../_static/anaconda.svg + :text-align: center -.. raw:: html + **Conda environment** + ^^^ -
-
-
-
-
- PyPI logo -
-

For Linux user we provide a step-by-step guide on how to install gospl and its dependencies using PyPI.

+ For Anaconda users, an environment with specific collection of conda packages and goSPL dependencies is available. -.. container:: custom-button + +++ - :ref:`Learn more ` + .. button-ref:: installConda + :color: secondary + :click-parent: -.. raw:: html + Learn more -
-
-
-
-
- Python logo -
-

gospl can also be installed directly from source but this requires installation of all other dependencies.

+ .. grid-item-card:: + :img-top: ../_static/pypi.svg + :text-align: center -.. container:: custom-button + **PyPI Linux wheel** + ^^^ - :ref:`Learn more ` + For Linux user we provide a step-by-step guide on how to install goSPL and its dependencies using PyPI. -.. raw:: html + +++ -
-
-
-
-
+ .. button-ref:: installPypi + :color: secondary + :click-parent: + + Learn more + + .. grid-item-card:: + :img-top: ../_static/python.svg + :text-align: center + + **Install from source** + ^^^ + + goSPL can also be installed directly from source but this requires installation of all other dependencies. + + +++ + + .. button-ref:: installSrc + :color: secondary + :click-parent: + + Learn more .. toctree::