Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added pip install (with docs) #280

Merged
merged 45 commits into from
Feb 26, 2024
Merged
Changes from 1 commit
Commits
Show all changes
45 commits
Select commit Hold shift + click to select a range
c5786dc
add pyproject.toml to download packages prior to build
ACea15 May 30, 2023
fb40764
minimal env (only for people without low level libraries in system)
ACea15 May 30, 2023
70b8b18
less restricted cmake in the setup (>= added)
ACea15 May 30, 2023
330ef4e
add functions to setup to build submodules
ACea15 May 30, 2023
216bd5b
add required packages to pip install
ACea15 May 30, 2023
a9c3194
remove unnecessary environments (leaving newer for reference)
ACea15 May 31, 2023
85a4475
add option, via environment variable, to not build submodules
ACea15 May 30, 2023
d0ee119
fix to env for Ubuntu
ACea15 May 31, 2023
780714b
fix wrong location of variable this_directory in merging conflicts
ACea15 May 31, 2023
a8d5884
simple compilation from run() method
ACea15 Jun 21, 2023
1b0f8af
minor environment compatibility for macos
ACea15 Jun 28, 2023
4b5a520
Merge pull request #266 from ImperialCollegeLondon/fix_linear_goland_…
ben-l-p Nov 2, 2023
4937efe
Merge branch 'develop' into dev_pip2
ben-l-p Nov 2, 2023
6529a26
Added documentation for pip install
ben-l-p Jan 26, 2024
f390ea0
Remove conda/mambda from Github workflow
ben-l-p Jan 26, 2024
4514dea
Update dockerfile to remove mamba/conda dependency
ben-l-p Jan 26, 2024
52a282e
Added CMake install to Dockerfile
ben-l-p Jan 26, 2024
fccaf87
Update Dockerfile
ben-l-p Jan 26, 2024
de8c9ec
Update Dockerfile
ben-l-p Jan 26, 2024
4b853cf
Update Dockerfile
ben-l-p Jan 26, 2024
fa2814a
Update Dockerfile
ben-l-p Jan 26, 2024
75e3060
Update Dockerfile
ben-l-p Jan 26, 2024
64e1e68
Update Dockerfile
ben-l-p Jan 30, 2024
c986f46
Update Dockerfile
ben-l-p Jan 30, 2024
b32b3a4
Update Dockerfile
ben-l-p Jan 30, 2024
c1bbc79
Update Dockerfile
ben-l-p Jan 30, 2024
00ceec2
Update Dockerfile
ben-l-p Jan 30, 2024
3f922bc
Update Dockerfile
ben-l-p Jan 30, 2024
47cd979
Update Dockerfile
ben-l-p Jan 30, 2024
da725ce
Update Dockerfile
ben-l-p Jan 30, 2024
03a4d0f
Update Dockerfile
ben-l-p Jan 30, 2024
226a6b7
Return Dockerfile to using conda/mamba
ben-l-p Feb 8, 2024
eb32df5
Update installation.md
ben-l-p Feb 8, 2024
04294e0
Merge branch 'ImperialCollegeLondon:main' into dev_pip2
ben-l-p Feb 8, 2024
ce51ac7
Added note about different pip install options
ben-l-p Feb 11, 2024
e33d2cc
Use latest mayavi from Github
ben-l-p Feb 20, 2024
6540174
Changed docs to include auto built, added ARM64 Conda environment
ben-l-p Feb 20, 2024
03928aa
Small documentation update
ben-l-p Feb 21, 2024
4e1e22a
Changed docs to use --user flag as default for installation
ben-l-p Feb 26, 2024
2441ee1
Added a few more install dependencies to the docs
ben-l-p Feb 26, 2024
719dcfa
Update installation.md
rafapalacios Feb 26, 2024
85b0392
Merge branch 'ImperialCollegeLondon:main' into dev_pip2
ben-l-p Feb 26, 2024
646e5f0
Removed SciPy FFT fix - will add to another pull request
ben-l-p Feb 26, 2024
57dcbab
Merge branch 'dev_pip2' of https://github.com/ben-l-p/sharpy into dev…
ben-l-p Feb 26, 2024
906a566
Readded SciPy FFT changes
ben-l-p Feb 26, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Added note about different pip install options
ben-l-p authored Feb 11, 2024
commit ce51ac74cd98783ae24c60aa902a3011f1d0a75f
23 changes: 11 additions & 12 deletions docs/source/content/installation.md
Original file line number Diff line number Diff line change
@@ -54,49 +54,48 @@ once you initialise SHARPy you will also automatically clone the relevant versio

2. We will now set up the SHARPy environment that will install other required distributions.

### Setting up the Python Environment (Standalone)
### Quick install (Standalone)

SHARPy can be installed as a standalone package, without the use of a package manager. If you wish to install using the Anaconda package manager, please use the following tutorial [HERE](#setting-up-the-python-environment-anaconda), or make a custom installation with a develop build or modified compilation settings [HERE](#custom-installation).
SHARPy can be installed as a standalone package, without the use of a package manager. If you wish to install using the Anaconda package manager, please use the following tutorial [HERE](#setting-up-the-python-environment-anaconda), or make a custom installation with a develop build or modified compilation settings [HERE](#custom-installation). The quick install is geared towards getting the release build of SHARPy running as quickly and simply as possible.

1. Check that your Python version is 3.10. Higher versions may be incompatible with the required modules.
1. Check that your Python version is 3.10. Other versions may be incompatible with the required modules.
```bash
python --version
```

### Quick install (Standalone)
The quick install is geared towards getting the release build of SHARPy running as quickly and simply as possible.
1. Move into the cloned repository:

2. Move into the cloned repository:
```bash
cd sharpy
```

2. Create a directory `build` that will be used during CMake's building process and `cd` into it.
3. Create a directory `build` that will be used during CMake's building process and `cd` into it.
Ensure it is located in the main ./sharpy folder otherwise the following steps won't work:
```bash
mkdir build
cd build
```

3. Prepare UVLM and xbeam for compilation using `gfortran` and `g++` in their release builds running. If you'd like to
4. Prepare UVLM and xbeam for compilation using `gfortran` and `g++` in their release builds running. If you'd like to
change compilers see the Custom Installation.
```bash
cmake ..
```

4. Compile the libraries.
5. Compile the libraries.
```bash
make install -j 4
```
where the number after the `-j` flag will specify how many cores to use during installation.
This should take approximately 2 minutes (Tested on MacOS Sonoma).

7. Finally, leave the build directory and install SHARPy:
6. Finally, leave the build directory and install SHARPy:
```bash
cd ..
pip install .
```
There are options for what to install if required. For instance, to install the basic package with documentation, just do ```bash pip install .[docs]```. For the whole lot, ```bash pip install .[all]```.

8. You can check the version of SHARPy you are running with:
7. You can check the version of SHARPy you are running with:
```bash
sharpy --version
```