Skip to content

Commit

Permalink
fix: Correct typos and improve clarity in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
mendzmartin committed Nov 16, 2024
1 parent 9745cc0 commit 60f6e8f
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 9 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,10 @@
- [Contact](#contact)

## **Usage**
Julia package repository to resolve Time-Independent Schrödinger equation by (F)init (E)lement (M)ethod. This is an implementation of Gridap package for unidimensional and bidimensional grids.
Julia package repository to resolve Time-Independent Schrödinger equation (TISE) by Finite Element Method (FEM). This is an implementation of [GRIDAP](https://github.com/gridap/Gridap.jl) package for unidimensional and bidimensional grids.

Project carried out in my PhD studies of Physics at:
* [Faculty of Mathematics, Astronomy, Physics and Computation (FaMAF)](https://www.famaf.unc.edu.ar/)
* [Faculty of Mathematics, Astronomy, Physics and Computation (FAMAF)](https://www.famaf.unc.edu.ar/)
* The Enrique Gaviola Institute of Physics (IFEG)

## **Installation**
Expand All @@ -37,10 +37,10 @@ Project carried out in my PhD studies of Physics at:
- [Run from Julia REPL](https://mendzmartin.github.io/FEMTISE.jl/dev/guide_information/#Run-from-Julia-REPL)

## **Documentation**
Check [here](https://mendzmartin.github.io/FEMTISE.jl/) The GitHub Page to see documentation.
Check [here](https://mendzmartin.github.io/FEMTISE.jl/) the GitHub Page to see documentation.

## **Tutorials**
See some use examples in [test folder](https://github.com/mendzmartin/FEMTISE.jl/tree/main/test) where you can find some tests of specific `FEMTISE` package's functions:
See some use examples in [test folder](https://github.com/mendzmartin/FEMTISE.jl/tree/main/test) where you can find some tests of specific `FEMTISE` package functions:
- Finite Well Potential 1D
- Symmetric Finite Kronig-Penney Potential 1D
- Isotropic Quantum Harmonic Oscillator 2D
Expand All @@ -55,4 +55,4 @@ Also, you can find tutorials in [FEMTISE_TUTORIAL](https://github.com/mendzmarti
or check FEMTISE Package [GitHub Page](https://mendzmartin.github.io/FEMTISE.jl/) to see documentation.

## **Contact**
Please, contact the project administrator [Méndez Martín](mailto:martinmendez@mi.unc.edu.ar) for any improve suggestion or questions about package use.
Please, contact the project administrator [Mendez Martin](mailto:[email protected]) for any improve suggestion or questions about package use.
2 changes: 1 addition & 1 deletion docs/src/contact_information.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
## **Contact**
Please, contact the project administrator [Méndez Martín](mailto:[email protected]) for any improve suggestion or questions about package use.
Please, contact the project administrator [Mendez Martin](mailto:[email protected]) for any improve suggestion or questions about package use.
2 changes: 1 addition & 1 deletion docs/src/examples/simulation_example.md
Original file line number Diff line number Diff line change
Expand Up @@ -336,7 +336,7 @@ Then you can run the script and set option `5` like this:
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
The type of default potential can be:
- Unidimensional Quantum Harmonic Oscillator --> set (1)
- Unidimensional Symmetric Finit Kronig-Penney --> set (2)
- Unidimensional Symmetric Finite Kronig-Penney --> set (2)
- Unidimensional Finite Well Potential --> set (3)
- Bidimensional Isotropic Quantum Harmonic Oscillator --> set (4)
- Ad hoc potential from input file --> set (5)
Expand Down
4 changes: 2 additions & 2 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@

*A documentation generator for Julia.*

Julia package repository to resolve Time-Independent Schrödinger equation by (F)init (E)lement (M)ethod. This is an implementation of Gridap package for unidimensional and bidimensional grids.
Julia package repository to resolve Time-Independent Schrödinger equation (TISE) by Finite Element Method (FEM). This is an implementation of GRIDAP package for unidimensional and bidimensional grids.

Project carried out in my PhD studies of Physics at:
* [Faculty of Mathematics, Astronomy, Physics and Computation (FaMAF)](https://www.famaf.unc.edu.ar/)
* [Faculty of Mathematics, Astronomy, Physics and Computation (FAMAF)](https://www.famaf.unc.edu.ar/)
* The Enrique Gaviola Institute of Physics (IFEG)

0 comments on commit 60f6e8f

Please sign in to comment.