Change README for PyPI

Author: nicoguaro

HISTORY.rst

@@ -1,7 +1,7 @@
 History
 -------
 
-1.1.0 (2023-03-02)
+1.1.0 (2023-11-03)
 ~~~~~~~~~~~~~~~~~~
 
 * Remove NumPy types in the code that were removed since NumPy 1.24

README.md

@@ -1,52 +1,51 @@
 # SolidsPy: 2D-Finite Element Analysis with Python
 
-![](https://raw.githubusercontent.com/AppliedMechanics-EAFIT/SolidsPy/master/docs/img/wrench.png)
+![](https://raw.githubusercontent.com/AppliedMechanics-EAFIT/SolidsPy/master/docs/img/wrench.png) 
 [![PyPI download](https://img.shields.io/pypi/v/solidspy.svg)](https://pypi.python.org/pypi/continuum_mechanics)
 [![Documentation Status](https://readthedocs.org/projects/solidspy/badge/?version=latest)](https://solidspy.readthedocs.io/en/latest/)
-[![Downloads frequency](https://img.shields.io/pypi/dm/solidspy)](https://pypistats.org/packages/solidspy) 
+[![Downloads frequency](https://img.shields.io/pypi/dm/solidspy)](https://pypistats.org/packages/solidspy)
 [![image](https://zenodo.org/badge/48294591.svg)](https://zenodo.org/badge/latestdoi/48294591)
 
-A simple finite element analysis code for 2D elasticity problems. The
-code uses as input simple-to-create text files defining a model in terms
-of nodal, element, material and load data.
+A simple finite element analysis code for 2D elasticity problems. The code uses
+as input simple-to-create text files defining a model in terms of nodal,
+element, material and load data.
 
 -   Documentation: <http://solidspy.readthedocs.io>
 -   GitHub: <https://github.com/AppliedMechanics-EAFIT/SolidsPy>
 -   PyPI: <https://pypi.org/project/solidspy/>
--   Free and open source software: [MIT
-    license](http://en.wikipedia.org/wiki/MIT_License)
+-   Free and open source software: [MIT license](http://en.wikipedia.org/wiki/MIT_License)
 
 ## Features
 
--   It is based on an open-source environment.
--   It is easy to use.
--   The code allows to find displacement, strain and stress solutions
-    for arbitrary two-dimensional domains discretized into finite
-    elements and subject to point loads.
--   The code is organized in independent modules for pre-processing,
-    assembly and post-processing allowing the user to easily modify it
-    or add features like new elements or analyses pipelines.
--   It was created with academic and research purposes.
--   It has been used to tech the following courses:
-    -   Computational Modeling.
-    -   Introduction to the Finite Element Methods.
+-  It is based on an open-source environment.
+-  It is easy to use.
+-  The code allows to find displacement, strain and stress solutions
+   for arbitrary two-dimensional domains discretized into finite
+   elements and subject to point loads.
+-  The code is organized in independent modules for pre-processing,
+   assembly and post-processing allowing the user to easily modify it
+   or add features like new elements or analyses pipelines.
+-  It was created with academic and research purposes.
+-  It has been used to tech the following courses:
+    - Introduction to Solid Mechanics.
+    - Computational Modeling.
+    - Introduction to the Finite Element Methods.
+    - Introduction to Soil Mechanics.
 
 ## Installation
 
-The code is written in Python and it depends on `numpy`, and `scipy`
-and. It has been tested under Windows, Mac, Linux and Android.
+The code is written in Python and it depends on `numpy`, and `scipy` and. It
+has been tested under Windows, Mac, Linux and Android.
 
 To install *SolidsPy* open a terminal and type:
 
     pip install solidspy
 
-To specify through a GUI the folder where the input files are stored you
-will need to install
-[easygui](http://easygui.readthedocs.org/en/master/).
+To specify through a GUI the folder where the input files are stored you will
+need to install [easygui](http://easygui.readthedocs.org/en/master/).
 
 To easily generate the required SolidsPy text files out of a
-[Gmsh](http://gmsh.info/) model you will need
-[meshio](https://github.com/nschloe/meshio).
+[Gmsh](http://gmsh.info/) model you will need [meshio](https://github.com/nschloe/meshio).
 
 These two can be installed with:
 
@@ -55,12 +54,10 @@ These two can be installed with:
 
 ## How to run a simple model
 
-For further explanation check the
-[docs](http://solidspy.readthedocs.io/en/latest/).
+For further explanation check the [docs](http://solidspy.readthedocs.io/en/latest/).
 
-Let\'s suppose that we have a simple model represented by the following
-files (see [tutorials/square
-example](http://solidspy.readthedocs.io/en/latest/tutorials/square_example.html)
+Let's suppose that we have a simple model represented by the following files
+(see [tutorials/square example](http://solidspy.readthedocs.io/en/latest/tutorials/square_example.html)
 for further explanation).
 
 -   `nodes.txt`
@@ -113,15 +110,12 @@ disp = solids_GUI()  # run the Finite Element Analysis
 plt.show()    # plot contours
 ```
 
-For Mac users it is suggested to use an IPython console to run the
-example.
+For Mac users it is suggested to use an IPython console to run the example.
 
 ## License
 
-This project is licensed under the [MIT
-license](http://en.wikipedia.org/wiki/MIT_License). The documents are
-licensed under [Creative Commons Attribution
-License](http://creativecommons.org/licenses/by/4.0/).
+This project is licensed under the [MIT license](http://en.wikipedia.org/wiki/MIT_License).
+The documents are licensed under [Creative Commons Attribution License](http://creativecommons.org/licenses/by/4.0/).
 
 ## Citation
 
@@ -132,17 +126,16 @@ To cite SolidsPy in publications use
 
 A BibTeX entry for LaTeX users is
 
-``` bibtex
+```bibtex
 @software{solidspy,
  title = {SolidsPy: 2D-Finite Element Analysis with Python},
  version = {1.1.0},
  author = {Guarín-Zapata, Nicolás and Gómez, Juan},
  year = 2023,
  keywords = {Python, Finite elements, Scientific computing, Computational mechanics},
- abstract = {SolidsPy is a simple finite element analysis code for
-   2D elasticity problems. The code uses as input simple-to-create text
-   files defining a model in terms of nodal, element, material and
-   load data.},
+ abstract = {SolidsPy is a simple finite element analysis code for 2D elasticity
+ problems. The code uses as input simple-to-create text files defining a model
+ in terms of nodal, element, material and load data.},
  url = {https://github.com/AppliedMechanics-EAFIT/SolidsPy},
  doi = {https://doi.org/10.5281/zenodo.7694030}
 }

setup.py

@@ -14,9 +14,13 @@
 here = path.abspath(path.dirname(__file__))
 
 # Get the long description from the README file
-with open(path.join(here, 'README.md'), encoding='utf-8') as f:
+with open('README.md', 'r', encoding='utf-8') as f:
     long_description = f.read()
 
+
+
+
+
 requirements = ['numpy',
                 'scipy',
                 'matplotlib',
@@ -26,7 +30,7 @@
 setup(
     name='solidspy',
 
-    version='1.1.0',
+    version='1.1.0.post1',
 
     description='A simple Finite Element program',
     long_description=long_description,