Skip to content

Commit

Permalink
modify the installation
Browse files Browse the repository at this point in the history
  • Loading branch information
ChunHuangPhy committed Nov 12, 2024
1 parent b692b64 commit e01c4e9
Showing 1 changed file with 36 additions and 25 deletions.
61 changes: 36 additions & 25 deletions docs/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,34 +26,37 @@ If you are not using Anaconda, you can create a virtual environment using Python
source CompactObject/bin/activate
3. **Install the Dependencies**
3. **Install the CompactObject package**

Once the environment is activated, you can install the dependencies using `pip`:
Once the environment is activated, you can install the package from PyPI, which is called `CompactObject-TOV`:

.. code-block:: bash
pip install -r requirements.txt
4. **Install CompactObject**

You can install the CompactObject package using `pip` inside the repository directory:
pip install CompactObject-TOV
The dependencies should be automatically installed for you.
while if you have trouble to use pip install, maybe you could git clone this repository, Then

.. code-block:: bash
pip install -r requirements.txt
pip install -e .
Alternatively, you can also install the package from PyPI, which is called `CompactObject-TOV`:
**Alternative**:

.. code-block:: bash
You can install the CompactObject package using pip inside the repository directory:

pip install CompactObject-TOV
To upgrade to the latest version on PyPI, run:
.. code-block:: bash
pip install -e .
To upgrade to the latest version on PyPI, run:
.. code-block:: bash
pip install CompactObject-TOV --upgrade
5. **Using the Package**

You are now ready to use CompactObject. Each time you want to use the package, ensure you activate the environment:
Expand Down Expand Up @@ -90,23 +93,31 @@ Alternative: Using Anaconda
**Note:** Once you create this environment, you don't need to create it again. Simply activate it whenever you want to use CompactObject.

3. **Install the Dependencies**
3. **Install the CompactObject package**

Once the environment is activated, you can install the dependencies using `pip`:
Once the environment is activated, you can install the package from PyPI, which is called `CompactObject-TOV`:

.. code-block:: bash
pip install CompactObject-TOV
The dependencies should be automatically installed for you.

while if you have trouble to use pip install, maybe you could git clone this repository, Then

pip install -r requirements.txt
4. **Install CompactObject**
.. code-block:: bash
pip install -r requirements.txt
Use `pip` to install the CompactObject package:
**Alternative**:

You can install the CompactObject package using pip inside the repository directory:

.. code-block:: bash
pip install -e .
pip install CompactObject-TOV
To upgrade to the latest version, run:
To upgrade to the latest version on PyPI, run:
.. code-block:: bash
Expand Down Expand Up @@ -137,7 +148,7 @@ Alternative: Using Anaconda
.. - `ultranest`
`CompactObject-TOV` optionally depends on `numbaminpack`. However, it may hard to install if don't have a fortran complier. Please
refer to this page `NumbaMinpack documentation <https://pypi.org/project/NumbaMinpack/>`, and you can skip
refer to this page `NumbaMinpack documentation <https://pypi.org/project/NumbaMinpack/>`_, and you can skip
this dependency if you are not using "fastRMF_EoS" and "pQCD"

.. Summary
Expand Down

0 comments on commit e01c4e9

Please sign in to comment.