Commit 2943babb authored by Jonathan Lambrechts's avatar Jonathan Lambrechts
Browse files

add readme

parent 3f11480e
Pipeline #7906 passed with stages
in 3 minutes and 46 seconds
Seamesh
=======
Seamsh_ is a python library wrapping gmsh_, gdal_ and scipy_ to simplify the generation of unstructured meshes. It is primarily developed for coastal ocean simulations but can be used in other GIS contexts.
test
Seamsh allows to :
- import ESRI shapefiles to define tagged domain boundaries, interior lines and interior points
- define arbitrary mesh elements size fields based on distances from lines or raster files
- create a low-resolution valid topology from high-resolution non conformal (i.e. intersecting) data
.. _gmsh : https://www.gmsh.info
.. _gdal : https://gdal.org
.. _scipy : https://www.scipy.org
.. _Seamsh : https://git.immc.ucl.ac.be/jlambrechts/seamsh
Seamesh is distributed under the GPL_. See the gitlab page of the project for the `source code`__ , documentation__ and `bug reports`__
Binary packages for 64 bits linux, windows and OSX are available on pypi_.
__ https://git.immc.ucl.ac.be/jlambrechts/seamsh
__ http://jlambrechts.git-page.immc.ucl.ac.be/seamsh
__ https://git.immc.ucl.ac.be/jlambrechts/seamsh/-/issues
.. _GPL : https://www.gnu.org/licenses/gpl-3.0.html
.. _pypi : https://test.pypi.org/project/seamsh
Installation
============
Examples
========
Welcome to seamsh's documentation!
==================================
Seamsh Documentation
====================
.. include:: ../Readme.rst
.. include:: demo.rst
......
......@@ -22,12 +22,11 @@ import setuptools
import sys
import os
#with open("README.md", "r") as fh:
# long_description = fh.read()
with open("Readme.rst", "r") as fh:
long_description = fh.read()
long_description_content_type = "text/x-rst"
long_description =''
version = "0.0.1"
version = "0.0.2"
commit_tag = os.environ.get("CI_COMMIT_TAG")
if commit_tag and (commit_tag.startswith("v-") or commit_tag.startswith("w-")):
version = commit_tag[2:]
......
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