You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
36 lines
933 B
36 lines
933 B
========
|
|
Geometry
|
|
========
|
|
This repository contains code for the Geometry library, which is available both as a
|
|
C++ library and a Python module. The documentation is up `here <https://acem.ece.illinois.edu/docs/Geometry/>`__.
|
|
|
|
Building
|
|
--------
|
|
All that is required is a working Python installation. First, clone the repository
|
|
|
|
.. code-block:: sh
|
|
|
|
$ git clone https://git.acem.ece.illinois.edu/gonzalo9/HybridMesher.git
|
|
$ cd HybridMesher
|
|
|
|
You may also need to install a few other tools, such as ``m4`` and ``cmake`` if they are not
|
|
already installed. A new version of ``cmake`` is needed. Next, we build the dependencies by running
|
|
|
|
.. code-block:: sh
|
|
|
|
$ ./PRE_SETUP
|
|
$ ./SETUP
|
|
|
|
Lastly, you can build the Python module by running the Makefile
|
|
|
|
.. code-block:: sh
|
|
|
|
$ make python
|
|
|
|
Documentation
|
|
-------------
|
|
To build the documentation, you simply only need to run the Makefile
|
|
|
|
.. code-block:: sh
|
|
|
|
$ make docs
|
|
|