Skip to content

Commit

Permalink
Update manual (installation)
Browse files Browse the repository at this point in the history
  • Loading branch information
abelcarreras committed Apr 21, 2021
1 parent 2d7d4bd commit 5a4d3e6
Showing 1 changed file with 30 additions and 4 deletions.
34 changes: 30 additions & 4 deletions docs/install.rst
Original file line number Diff line number Diff line change
@@ -1,17 +1,43 @@
.. highlight:: rst

Install
=======
Installation
============

:program:`cosymlib` is available in both GitHub and PyPI repositories (https://pypi.org/project/cosymlib/).
Installation via PyPI is simpler and it is recommended for most users.

Requirements
____________
:program:`cosymlib` contains libraries written in Fortran that require a compiler to build them.
Before installing cosymlib make sure you have a working Fortran compiler installed in your system.
For UNIX based systems you can install it from package repositories by opening a terminal and typing
the following commands:

- **Linux**

On YUM-based systems (Feodora/RedHat/CentOS) ::

sudo yum install yum-utils

On APT-based systems (Debian/Ubuntu) ::

sudo apt-get build-dep

- **Mac**

1. Install command-line tools: ::

xcode-select --install

2. Get Homebrew following the instructions at https://brew.sh, and install GCC formula by: ::

brew install gcc

Install from PyPI
_________________

This installation requires :program:`pip` ( https://pip.pypa.io/en/stable/installing/) to be installed
in your system. Once pip is properly installed you can install :program:`cosymlib` by typing the following
command in the terminal: ::
in your system. Once pip is properly installed you can install :program:`cosymlib` by typing: ::

pip install cosymlib --user

Expand Down

0 comments on commit 5a4d3e6

Please sign in to comment.