Skip to content
Snippets Groups Projects
Commit af94c1a0 authored by Christophe Geuzaine's avatar Christophe Geuzaine
Browse files

improve readme

parent b2d00060
No related branches found
No related tags found
No related merge requests found
...@@ -6,8 +6,9 @@ gmsh-dev ...@@ -6,8 +6,9 @@ gmsh-dev
mesh generator with built-in pre- and post-processing facilities. mesh generator with built-in pre- and post-processing facilities.
The aim of this package is to download and install the latest development The aim of this package is to download and install the latest development
snapshot of the Gmsh app and SDK in a pythonic way, i.e. via the ``pip`` snapshot of the official Gmsh app and binary Software Development Kit SDK in a
command. For the latest stable release, use the ``gmsh`` package instead. pythonic way, i.e. via the ``pip`` command. For the latest stable release, use
the ``gmsh`` package instead.
Installation should work under Linux, Windows and macOS for both Python 2 and 3. Installation should work under Linux, Windows and macOS for both Python 2 and 3.
...@@ -21,10 +22,17 @@ latest development snapshot:: ...@@ -21,10 +22,17 @@ latest development snapshot::
$ pip install --force-reinstall --no-cache-dir gmsh-dev $ pip install --force-reinstall --no-cache-dir gmsh-dev
This can take a few seconds to a few minutes depending on your network
connection, as the installer downloads the binary files for your architecture
from https://gmsh.info.
After installation you can either run the Gmsh app:: After installation you can either run the Gmsh app::
$ gmsh $ gmsh
or use the Gmsh Python API:: or use the Gmsh Python API::
$ python -c "import gmsh; gmsh.initialize(); gmsh.fltk.run();" $ python -c "import gmsh; gmsh.initialize(); gmsh.fltk.run(); gmsh.finalize()"
(Note that the header files for using the C++ and C API are also installed, as
is the Julia module.)
...@@ -19,7 +19,7 @@ from ctypes.util import find_library ...@@ -19,7 +19,7 @@ from ctypes.util import find_library
# Server and gmsh version # Server and gmsh version
server = 'https://gmsh.info/bin' server = 'https://gmsh.info/bin'
version = '${GMSH_MAJOR_VERSION}.${GMSH_MINOR_VERSION}.${GMSH_PATCH_VERSION}' version = '${GMSH_MAJOR_VERSION}.${GMSH_MINOR_VERSION}.${GMSH_PATCH_VERSION}'
iversion = version + '.dev4' # installer version iversion = version + '.dev5' # installer version
# Determine file name and and url to be downloaded and installed # Determine file name and and url to be downloaded and installed
system = platform.system().lower() system = platform.system().lower()
......
...@@ -5,8 +5,9 @@ gmsh ...@@ -5,8 +5,9 @@ gmsh
`Gmsh <https://gmsh.info>`_ is an automatic three-dimensional finite element `Gmsh <https://gmsh.info>`_ is an automatic three-dimensional finite element
mesh generator with built-in pre- and post-processing facilities. mesh generator with built-in pre- and post-processing facilities.
The aim of this package is to download and install the Gmsh app and SDK in a The aim of this package is to download and install the official Gmsh app and
pythonic way, i.e. via the ``pip`` command. binary Software Development Kit (SDK) in a pythonic way, i.e. via the ``pip``
command.
Installation should work under Linux, Windows and macOS for both Python 2 and 3. Installation should work under Linux, Windows and macOS for both Python 2 and 3.
...@@ -19,10 +20,17 @@ Then install (or upgrade) ``gmsh``:: ...@@ -19,10 +20,17 @@ Then install (or upgrade) ``gmsh``::
$ pip install --upgrade gmsh $ pip install --upgrade gmsh
This can take a few seconds to a few minutes depending on your network
connection, as the installer downloads the binary files for your architecture
from https://gmsh.info.
After installation you can either run the Gmsh app:: After installation you can either run the Gmsh app::
$ gmsh $ gmsh
or use the Gmsh Python API:: or use the Gmsh Python API::
$ python -c "import gmsh; gmsh.initialize(); gmsh.fltk.run();" $ python -c "import gmsh; gmsh.initialize(); gmsh.fltk.run(); gmsh.finalize()"
(Note that the header files for using the C++ and C API are also installed, as
is the Julia module.)
...@@ -18,7 +18,7 @@ from setuptools.command.install import install ...@@ -18,7 +18,7 @@ from setuptools.command.install import install
# Server and gmsh version # Server and gmsh version
server = 'https://gmsh.info/bin' server = 'https://gmsh.info/bin'
version = '${GMSH_MAJOR_VERSION}.${GMSH_MINOR_VERSION}.${GMSH_PATCH_VERSION}' version = '${GMSH_MAJOR_VERSION}.${GMSH_MINOR_VERSION}.${GMSH_PATCH_VERSION}'
iversion = version + '' # installer version (add e.g. '.post1' for update) iversion = version + '.post3' # installer version (add e.g. '.post1' for update)
# Determine file name and and url to be downloaded and installed # Determine file name and and url to be downloaded and installed
system = platform.system().lower() system = platform.system().lower()
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment