Update install instruction

mpasson · Aug 3, 2023 · a8e9a96 · a8e9a96
1 parent 33eaad8
commit a8e9a96
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/Docs/intro.rst b/Docs/intro.rst
@@ -6,14 +6,13 @@ This is the draft documentation for the A_FMM package. It is a work in progress.
 
 Installation
 -------------
-To install the packages dependencies, just use the provided **requirements.txt** file, by running:
+You can install A_FMM directly from pypi by running:
 
 
 .. code-block::
     
-    pin install -r requirements.txt
+    pip install A_FMM
 
-Then, just make sure the folder A_FMM is added to the PYTHONPATH environment variable.
 
 Method Overview
 -----------------

diff --git a/README.md b/README.md
@@ -7,7 +7,10 @@
 This is a Python implementation the Aperiodic-Fourier Modal Method, a fully vectorial method for solving Maxwell equations that combines a Fourier-based mode solver and a scattering matrix recursion algorithm to model full 3D structures. This approach is well suited to calculate modes, transmission, reflection, scattering and absorption of multi-layered structures. Moreover, support for Bloch modes of periodic structures allows for the simulation of photonic crystals or waveguide Bragg gratings.
 
 ## Installation
-As for now, the advised way of installing is to just clone the repository and add it to your PYTHONPATH environment variable.
+You can install A_FMM directly from pypi by running:
+
+    pip install A_FMM
+
 
 ## Documentation
 Full documentation is available on [Read the Docs](https://a-fmm.readthedocs.io)