Skip to content

Commit 0cb4690

Browse files
committed
updated tutorial3
1 parent 1657283 commit 0cb4690

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

73 files changed

+2387
-1871
lines changed

.gitignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,8 @@
77
build/
88
dist/
99
pygem.egg-info/
10+
11+
12+
# virtual environments
13+
venv_pygem/
14+
venv_pygem

README.md

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -50,17 +50,17 @@ See the [**Examples**](#examples) section below and the [**Tutorials**](tutorial
5050

5151

5252
## Dependencies and installation
53-
**PyGeM** requires `numpy`, `scipy`, `matplotlib`, `sphinx` (for the
54-
documentation) and `pytest` (for local test). They can be easily installed via
55-
`pip`. The code has been tested with Python3.7 version, but it should be
56-
compatible with a generic Python3.x. The Python2 support is no longer maintained.
53+
**PyGeM** requires `numpy`, `scipy`, and `matplotlib` as core dependencies. `sphinx` is needed for the
54+
documentation and `pytest` for testing. They can be easily installed via
55+
`pip`. The code has been tested with Python3.12.9 version, but it should be
56+
compatible with Python3.9+. The Python2 support is no longer maintained.
5757
To enable the `CAD`
5858
[submodule](https://github.com/mathLab/PyGeM/tree/master/pygem/cad), the
5959
module `pythonocc-core` is required to deal with IGES files. This requirement
6060
cannot be satisfied through `pip`, but the precompiled binaries are available
6161
on `conda` using the command:
6262
```bash
63-
conda install -c conda-forge pythonocc-core=7.4.0
63+
conda install -c conda-forge pythonocc-core
6464
```
6565
For additional information about the compilation and installation of
6666
`pythonocc`, we refer the original
@@ -76,7 +76,7 @@ The official distribution is on GitHub, and you can clone the repository using
7676
To install the package just type:
7777

7878
```bash
79-
> python setup.py install
79+
> pip install .
8080
```
8181

8282
To uninstall the package you have to rerun the installation and record the installed files in order to remove them:
@@ -85,6 +85,15 @@ To uninstall the package you have to rerun the installation and record the insta
8585
> pip uninstall pygem
8686
```
8787

88+
**Install directly from GitHub:**
89+
```bash
90+
pip install "pygem @ git+https://github.com/mathLab/PyGeM.git"
91+
```
92+
**Install with optional extras:**
93+
- For testing: `pip install "pygem[test]"`
94+
- For documentation: `pip install "pygem[docs]"`
95+
- For development (all extras): `pip install "pygem[dev]"`
96+
8897
### Docker
8998
Alternatively, a way to run the PyGeM library is to use our prebuilt and high-performance Docker images.
9099
Docker containers are extremely lightweight, secure, and are based on open standards that run on all major Linux distributions, macOS and Microsoft Windows platforms.
@@ -101,7 +110,7 @@ Once the download is complete you can start PyGeM for the first time. Just run:
101110
```bash
102111
> docker run -ti sissamathlab/pygem:latest
103112
```
104-
To facilitate the devoloping, using the text editor,version control and other tools already installed on your computers,
113+
To facilitate the developing, using the text editor,version control and other tools already installed on your computers,
105114
it is possible to share files from the host into the container:
106115

107116
```bash
@@ -127,7 +136,7 @@ The generated html can be found in `docs/build/html`. Open up the `index.html` y
127136

128137

129138
## Testing
130-
We are using Github Actions for continuous intergration testing. You can check out the current status [here](https://github.com/mathLab/PyGeM/actions/workflows/testing_pr.yml).
139+
We are using GitHub Actions for continuous integration testing. You can check out the current status [here](https://github.com/mathLab/PyGeM/actions/workflows/testing_pr.yml).
131140

132141
To run tests locally (the package `pytest` is required):
133142

@@ -232,7 +241,7 @@ Here there is a list of the scientific works involving **PyGeM** you can consult
232241

233242

234243
## Authors and contributors
235-
**PyGeM** is currently developed and mantained at [SISSA mathLab](http://mathlab.sissa.it/) by
244+
**PyGeM** is currently developed and maintained at [SISSA mathLab](http://mathlab.sissa.it/) by
236245
* [Marco Tezzele](mailto:[email protected])
237246
* [Nicola Demo](mailto:[email protected])
238247
* [Andrea Mola](mailto:[email protected])

0 commit comments

Comments
 (0)