Commit ad968fb6 authored by Baptiste Durand's avatar Baptiste Durand

Update installing instructions

+ Cleaning egg-info
parent 3f8d539b
......@@ -7,3 +7,4 @@
*.h5
demo/loc_E12_u.pdf
*.pyc.*
*.egg-info/
\ No newline at end of file
......@@ -924,14 +924,14 @@ sudo apt-get install --no-install-recommends fenics
<h3 id="installing">Installing</h3>
<p>The <strong>HO_homog</strong> Python package can be installed with <code>pip</code>.</p>
<ul>
<li>Install it from the gitlab repository directly (preferred way):</li>
<li>Install it directly from the gitlab repository :</li>
</ul>
<pre><code class="language-bash"><div>pip3 install git+https://baptiste.durand@gitlab.enpc.fr/baptiste.durand/HO_homog.git<span class="hljs-comment">#egg=ho_homog</span>
</div></code></pre>
<ul>
<li>Or <a href="https://gitlab.enpc.fr/baptiste.durand/HO_homog/repository/archive.tar?ref=master">download</a> the HO_homog repository files. Then, move to the HO_homog directory and use <code>pip</code> :</li>
<li>Or (recommended) <a href="https://gitlab.enpc.fr/baptiste.durand/HO_homog/repository/archive.tar?ref=master">download</a> / clone the HO_homog repository, then move to the HO_homog directory and use <code>pip</code> :</li>
</ul>
<pre><code class="language-bash"><div> pip3 install . --editable
<pre><code class="language-bash"><div>pip install --editable .
</div></code></pre>
<h4 id="recommended-tools">Recommended tools</h4>
<p>For designing microstructures and generating meshes with HO_homog features, gmsh and its SDK (Software Development Kit) must be installed.\
......
......@@ -47,16 +47,16 @@ Supposing FEniCS has been already installed on the system, the settings of the v
### Installing
The **HO_homog** Python package can be installed with `pip`.
- Install it from the gitlab repository directly (preferred way):
- Install it directly from the gitlab repository :
```bash
pip3 install git+https://baptiste.durand@gitlab.enpc.fr/baptiste.durand/HO_homog.git#egg=ho_homog
```
- Or [download](https://gitlab.enpc.fr/baptiste.durand/HO_homog/repository/archive.tar?ref=master) the HO_homog repository files. Then, move to the HO_homog directory and use `pip` :
- Or (recommended) [download](https://gitlab.enpc.fr/baptiste.durand/HO_homog/repository/archive.tar?ref=master) / clone the HO_homog repository, then move to the HO_homog directory and use `pip` :
```bash
pip3 install . --editable
pip install --editable .
```
#### Recommended tools
......
Metadata-Version: 2.1
Name: ho-homog
Version: 0.1
Summary: Numerical homogenization of periodic materials by use of a higher order homogenization scheme.
Home-page: https://gitlab.enpc.fr/baptiste.durand/HO_homog
Author: Baptiste Durand, Arthur Lebée
Author-email: baptiste.durand@enpc.fr
License: UNKNOWN
Description: <!-- # Project Title
One Paragraph of project description goes here -->
# HO_homog
**TODO** : *One Paragraph of project description goes here*
## Getting Started
The **HO_homog** project is developped on Ubuntu 18.04 with the programming language Python3.
The current stable release of the **HO_homog** Python library can be downloaded from this [repository](https://gitlab.enpc.fr/baptiste.durand/HO_homog/tree/master).
### Prerequisites
Before using the **HO_homog** tools FEniCS and `pip` (or setuptools) must be installed.
#### FEniCS
To install the FEniCS on Ubuntu, run the following commands:
```bash
sudo apt-get install software-properties-common
sudo add-apt-repository ppa:fenics-packages/fenics
sudo apt-get update
sudo apt-get install --no-install-recommends fenics
```
For more information about installation or instructions for other platforms see the [fenicsproject website](https://fenicsproject.org/download/) and the [FEniCS reference manual](https://fenics.readthedocs.io/en/latest/installation.html#debian-ubuntu-packages).
#### Virtual Environment
Using a virtual environment for Python projects is recommended. **HO_homog** and Gmsh can be installed inside a virtual environment but FEniCS cannot.
Make a new virtual environment :
```bash
python3 -m venv /path/to/project/project_name
```
Then activate it :
```bash
source /path/to/project/project_name/bin/activate
```
Now, the HO_homog package and its dependencies can be installed inside this virtual environment (see instructions below).
Supposing FEniCS has been already installed on the system, the settings of the virtual environment should be modified to make it accessible. In `/path/to/project/project_name/pyenv.cfg` : `include-system-site-packages = true`.
### Installing
The **HO_homog** Python package can be installed with `pip`.
- Install it from the gitlab repository directly (preferred way):
```bash
pip3 install git+https://baptiste.durand@gitlab.enpc.fr/baptiste.durand/HO_homog.git#egg=ho_homog
```
- Or [download](https://gitlab.enpc.fr/baptiste.durand/HO_homog/repository/archive.tar?ref=master) the HO_homog repository files. Then, move to the HO_homog directory and use `pip` :
```bash
pip3 install . --no-cache-dir
```
<!--
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
### Prerequisites
What things you need to install the software and how to install them
```
Give examples
```
### Installing
A step by step series of examples that tell you how to get a development env running
Say what the step will be
```
Give the example
```
And repeat
```
until finished
```
End with an example of getting some data out of the system or using it for a little demo
-->
<!--
## Running the tests
Explain how to run the automated tests for this system
### Break down into end to end tests
Explain what these tests test and why
```
Give an example
```
### And coding style tests
Explain what these tests test and why
```
Give an example
```
<!-- ## Deployment
Add additional notes about how to deploy this on a live system -->
## Built With
The HO_homog tools have been developped with Python 3.6.7.
They make use of the following applications. The numbers in brackets represent the versions used for the development.
- Python 3 (3.6.7);
- [Gmsh](http://gmsh.info/) - Used to generate finite element meshes, by means of its API for Python (4.0.6);
- [FEniCS](https://fenicsproject.org/) - Finite element computing platform (2018.1.0)
<!--
## Contributing
Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us.
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags). -->
## Authors
- **Baptiste Durand** - *PhD student* - Laboratoire NAVIER, UMR 8205 - [@baptiste.durand](https://gitlab.enpc.fr/baptiste.durand) - [baptiste.durand@enpc.fr](mailto:baptiste.durand@enpc.fr) - [Student page on Laboratoire Navier website](https://navier-lab.fr/baptiste-durand/)
- **Arthur Lebée** - *Researcher* - Laboratoire NAVIER, UMR 8205 - [@arthur.lebee](https://gitlab.enpc.fr/arthur.lebee) - [Researcher page on Laboratoire Navier website](https://navier-lab.fr/arthur-lebee/)
See also the graphs of all [contributions](https://gitlab.enpc.fr/baptiste.durand/HO_homog/graphs/master) to this project.
<!-- ## Authors
* **Billie Thompson** - *Initial work* - [PurpleBooth](https://github.com/PurpleBooth)
See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project. -->
<!-- ## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details -->
## Acknowledgments
The authors acknowledge the support of the French Agence Nationale de la Recherche (ANR), under grant ANR-17-CE08-0039 ([project ArchiMatHOS](http://www.agence-nationale-recherche.fr/Projet-ANR-17-CE08-0039)).
<img src="/img/ArchiMATHOS_ANR.png" height="250">
<!--
## Ressources pour la rédaction du fichier README
- [Cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) for writing in markdown.
- [Template](https://gist.github.com/PurpleBooth/109311bb0361f32d87a2) of a README<span></span>.md file.
- [Examples](https://github.com/matiassingers/awesome-readme) of readme files.
-->
Keywords: homogenization,higher-order asymptotic homogenization,strain gradient,materials,finite element method,FEM
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Operating System :: POSIX :: Linux
Classifier: Topic :: Scientific/Engineering
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: French
Requires-Python: >= 3.6
Description-Content-Type: text/markdown
README.md
setup.cfg
setup.py
ho_homog/__init__.py
ho_homog/full_scale_pb.py
ho_homog/homog2d.py
ho_homog/homog_beam.py
ho_homog/materials.py
ho_homog/mesh_tools.py
ho_homog/part.py
ho_homog/periodicity.py
ho_homog/toolbox_FEniCS.py
ho_homog/toolbox_gmsh.py
ho_homog.egg-info/PKG-INFO
ho_homog.egg-info/SOURCES.txt
ho_homog.egg-info/dependency_links.txt
ho_homog.egg-info/not-zip-safe
ho_homog.egg-info/requires.txt
ho_homog.egg-info/top_level.txt
test/test_cpp_expression.py
test/test_mesh_generate_2D.py
test/test_mesh_generate_pantograph.py
\ No newline at end of file
gmsh-sdk
matplotlib
more_itertools
numpy
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment