.. _getting-started:

Getting Started
===============

Installing
----------

Since this framework will not be maintained, you will not find it available in PyPI nor conda-forge. But, it's still possible to install it through pip with:

.. code:: bash

	pip install git+https://github.com/simpeg/inversion-design-ideas

Install from source
~~~~~~~~~~~~~~~~~~~

Alternatively, we could clone the repository and install the package from source.

1. Clone the repository:

   .. code:: bash

      git clone https://github.com/simpeg/inversion-design-ideas

2. Navigate to the cloned repository:

   .. code:: bash

      cd inversin-design-ideas

3. Use ``pip`` to install it:

   .. code:: bash

      pip install .