Skip to content

Commit

Permalink
Converted tests to use cgnsdiff (#54)
Browse files Browse the repository at this point in the history
Co-authored-by: Neil Wu <[email protected]>
  • Loading branch information
sseraj and ewu63 authored Oct 4, 2021
1 parent 8be521d commit 26916e2
Show file tree
Hide file tree
Showing 21 changed files with 202 additions and 1,984 deletions.
4 changes: 2 additions & 2 deletions .github/test_real.sh
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/bin/bash
set -e

cd reg_tests
cd tests
./ref/get-ref-files.sh
testflo . -v -n 1

cd ../examples
Expand Down
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,8 @@
*.fmt
*.lay
*.plt
*.cgns
*.out
*.egg-info
doc/tmp.rst
doc/_build
40 changes: 30 additions & 10 deletions doc/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,34 +23,54 @@ Compilation
pyHyp follows the standard MDO Lab build procedure.
To start, first clone the repo. For stability we recommend checking out a tagged release.

Next, find a configuration file close to your current setup in::
Next, find a configuration file close to your current setup in ``config/defaults`` and copy it to ``config/config.mk``.
For example:

$ config/defaults
.. prompt:: bash

and copy it to ``config/config.mk``. For example::

$ cp config/defaults/config.LINUX_GFORTRAN_OPENMPI.mk config/config.mk
cp config/defaults/config.LINUX_GFORTRAN_OPENMPI.mk config/config.mk

If you are a beginner user installing the packages on a Linux desktop,
you should use the ``config.LINUX_GFORTRAN_OPENMPI.mk`` versions of the configuration
files. The ``config.LINUX_INTEL.mk`` versions are usually used on clusters.

Once you have copied the config file, compile pyHyp by running::
Once you have copied the config file, compile pyHyp by running:

.. prompt:: bash

$ make
make

If everything was successful, the following lines will be printed to
the screen (near the end)::

Testing if module hyp can be imported...
Module hyp was successfully imported.

Finally, install the Python interface with::
Finally, install the Python interface with:

.. prompt:: bash

pip install .

Testing Your Installation
-------------------------

To test your installation, you can run some of the scripts in the ``examples`` folder or run the regression tests with ``testflo -v`` from the root directory.
Some of the examples require you to have `cgnsUtilities <https://github.com/mdolab/cgnsutilities>`_ installed.
To test your installation, you can run the regression tests.
Running the tests requires additional dependencies.
Check if you have these installed by running:

.. prompt:: bash

pip install .[testing]

Once you have the necessary dependencies, download the reference mesh files:

.. prompt:: bash

./reg_tests/ref/get-ref-files.sh

Then, in the root directory, run:

.. prompt:: bash

testflo -v
Loading

0 comments on commit 26916e2

Please sign in to comment.