Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .flake8
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[flake8]
exclude = venv, __init__.py, doc/_build, .venv
select = W191, W291, W293, W391, E115, E117, E122, E124, E125, E225, E231, E301, E303, E501, F401, F403
select = W191, W291, W293, W391, E115, E117, E122, E124, E125, E225, E231, E301, E303, E501, F401, F403, N801, N802, N803, N804, N805, N806, N807, N815, N816
count = True
max-complexity = 10
max-line-length = 100
Expand Down
47 changes: 15 additions & 32 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
pyrep
PyREP
=====
|pyansys| |python| |pypi| |GH-CI| |codecov| |MIT| |black|

Expand Down Expand Up @@ -33,49 +33,39 @@ pyrep

A Python client for Ansys REP - Remote Execution Platform

Note: The following README instructions are not yet fully tested and adapted for pyrep.

How to install
--------------

.. TODO: Update installation instructions, try to follow this general scheme as much as possible.

At least two installation modes are provided: user and developer.

For users
^^^^^^^^^

In order to install Pyrep rep, make sure you
In order to install PyREP, make sure you
have the latest version of `pip`_. To do so, run:

.. code:: bash

python -m pip install -U pip

Then, as long as pyrep is a private pyAnsys module not published to pypi yet, you can execute:
Then, as long as PyREP is a private pyAnsys module not published to pypi yet, you can execute:

.. code:: bash

python -m pip install git+https://github.com/pyansys/pyrep

.. TODO: Enable this once pyrep is published: python -m pip install ansys-rep

For developers
^^^^^^^^^^^^^^
Contribute
----------

Installing pyrep in developer mode allows
you to modify the source and enhance it.

Before contributing to the project, please refer to the `PyAnsys Developer's guide`_. You will
Before contributing to the project, ensure that you are thoroughly
familiar with the `PyAnsys Developer's guide`_. You will
need to follow these steps:

#. Start by cloning this repository:
#. Clone this repository:

.. code:: bash

git clone https://github.com/pyansys/pyrep
cd pyrep

#. Create a fresh-clean Python environment and activate it:
#. Create a new Python environment and activate it:

.. code:: bash

Expand Down Expand Up @@ -106,13 +96,6 @@ need to follow these steps:
.. code:: bash

python -m pip install --editable .

#. Finally, verify your development installation by running:

.. code:: bash

tox


How to testing
--------------
Expand All @@ -131,7 +114,7 @@ order to guarantee project's integrity. The following environments commands are
- **tox -e style**: will check for coding style quality.
- **tox -e py**: checks for unit tests.
- **tox -e py-coverage**: checks for unit testing and code coverage.
- **tox -e doc**: checs for documentation building process.
- **tox -e doc**: checks for documentation building process.


Raw testing
Expand All @@ -157,14 +140,14 @@ encouraged to install this tool via:
Documentation
-------------

For building documentation, you can either run the usual rules provided in the
`Sphinx`_ Makefile, such us:
For building documentation, you can manually run:

.. code:: bash

make -C doc/ html && your_browser_name doc/html/index.html
python prepare_documentation.py
python -m sphinx -b html doc/source build/sphinx/html

However, the recommended way of checking documentation integrity is using:
The recommended way of checking documentation integrity is using:

.. code:: bash

Expand Down
105 changes: 0 additions & 105 deletions README_dcs_py_client.md

This file was deleted.

81 changes: 0 additions & 81 deletions doc/source/conf_templ.py

This file was deleted.

49 changes: 0 additions & 49 deletions doc/source/examples/ex_adding_file.rst

This file was deleted.

5 changes: 2 additions & 3 deletions doc/source/examples/ex_cfx_static_mixer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,12 @@ This example shows how to submit a CFX Static Mixer model to be solved on REP.

The project setup script as well as the data files can be downloaded here :download:`CFX Static Mixer Example <../../../build/cfx_static_mixer.zip>`.

The project uses an execution script exec_cfx.py instead of a solver command line.
The execution script is located in this zip file :download:`Example Execution Scripts <../../../build/exec_scripts.zip>`.
The project uses an execution script `exec_cfx.py` instead of a solver command line.

.. literalinclude:: ../../../examples/cfx_static_mixer/project_setup.py
:language: python
:caption: project_setup.py

.. literalinclude:: ../../../examples/exec_scripts/exec_cfx.py
.. literalinclude:: ../../../examples/cfx_static_mixer/exec_cfx.py
:language: python
:caption: exec_cfx.py
Loading