Skip to content

Commit eedd7ae

Browse files
committed
Updated README and added AUTHORS file
1 parent 5633e42 commit eedd7ae

File tree

3 files changed

+23
-0
lines changed

3 files changed

+23
-0
lines changed

AUTHORS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Ahmed Ratnani, Mohamed Jalal Maaouni

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,21 @@
11
# Welcome to IGA-Python
2+
3+
Contains the source code of the [IGA-Python](https://pyccel.github.io/IGA-Python/) site.
4+
5+
## Editing and building IGA-Python locally
6+
7+
1. Clone this repository and then install the required dependencies.
8+
9+
```bash
10+
git clone https://github.com/pyccel/IGA-Python.git
11+
cd IGA-Python
12+
13+
# Install dependencies on a virtual environment
14+
python3 -m venv iga-python-env
15+
source iga-python-env/bin/activate
16+
pip3 install -r requirements.txt
17+
```
18+
19+
2. Edit the desired Python notebooks (`*.ipynb`) and/or Markdown files (`*.md`). Check the [MyST syntax cheat sheet](https://jupyterbook.org/en/stable/reference/cheatsheet.html) for reference.
20+
3. Build the docs by running `make`.
21+
4. View your changes on the browser: `open _build/html/index.html`

intro.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Home
22

3+
```{include} AUTHORS
4+
```
35

46
Welcome to IGA-Python, a tutorial for Isogeometric Analysis using Python.
57

0 commit comments

Comments
 (0)