-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
22 additions
and
29 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,56 +1,49 @@ | ||
# Installation | ||
|
||
To be able to run the examples in this guide, we recommend to follow these steps: | ||
To run the examples in this guide, we recommend to follow these steps: | ||
|
||
1. Download the [IGA-Python] source files. | ||
1. Download the [IGA-Python] repository and then install its dependencies. | ||
|
||
```bash | ||
# Download IGA-Python | ||
git clone https://github.com/pyccel/IGA-Python.git | ||
cd IGA-Python | ||
|
||
# Save and show the absolute path to the IGA-Python directory. | ||
IGA_PYTHON_DIR=$(realpath IGA-Python) | ||
echo "IGA_PYTHON_DIR=${IGA_PYTHON_DIR}" | ||
``` | ||
|
||
2. Create a virtual Python environment. | ||
|
||
```shell | ||
# Install required Python packages | ||
python3 -m venv iga-python-env | ||
|
||
# Save and show the absolute path to the IGA-Python environment script. | ||
IGA_PYTHON_ENV=$(realpath iga-python-env/bin/activate) | ||
echo "IGA_PYTHON_ENV=${IGA_PYTHON_ENV}" | ||
``` | ||
|
||
2. Install the necessary Python packages. | ||
|
||
```shell | ||
cd ${IGA_PYTHON_DIR} | ||
|
||
# Python packages required by IGA-Python will | ||
# be installed in IGA-Python virtual environment. | ||
source ${IGA_PYTHON_ENV} | ||
source iga-python-env/bin/activate | ||
pip3 install -r requirements.txt | ||
``` | ||
|
||
3. Launch Jupyter notebook. | ||
2. Access [IGA-Python] examples through Jupyter notebook. | ||
|
||
```shell | ||
# Run this command under IGA-Python folder | ||
jupyter notebook | ||
``` | ||
|
||
The above command should automatically launch your web browser and show you the [IGA-Python] files you've downloaded from Step 1: | ||
Running `jupyter notebook` should automatically launch your web browser and show you the files in the current directory—in this case the [IGA-Python] files: | ||
|
||
![png](images/ch1-jupyter-root.png) | ||
|
||
Try opening a sample notebook. Navigate to `chapter1/` and find `poisson.ipynb`: | ||
Try opening a sample notebook, e.g. `chapter1/poisson.ipynb`: | ||
|
||
![png](images/ch1-jupyter-poisson-1.png) | ||
|
||
|
||
Open `poisson.ipynb`. Check that you can successfully run all cells in this notebook. | ||
Open `poisson.ipynb` and verify that you can successfully run all cells in this notebook. | ||
|
||
![png](images/ch1-jupyter-poisson-2.png) | ||
|
||
|
||
3. When you close Jupyter and would like to run the [IGA-Python] examples, just open your Terminal/Console app and run these commands: | ||
|
||
```shell | ||
cd /full/path/to/your/IGA-Python # Change this to where your IGA-Python folder is located | ||
source iga-python-env/bin/activate | ||
jupyter notebook | ||
``` | ||
|
||
**Congratulations!** You can now head over to the [Poisson example problem](poisson.ipynb) to get started. | ||
|
||
[IGA-Python]: https://github.com/pyccel/IGA-Python.git |