The code structure of Nashpy¶
The directory structure¶
The directory structure for Nashpy is:
Here is a brief description of each of these:
src/ directory contains the source code. It’s structure is as
__init__.pyfile contains the various commands to import all the functionality of the library.
game.pyfile contains the main
algorithms/directory contains further modules with algorithms for computation of Nash equilibria.
integer_pivoting/directory contains further modules with algorithms for integer pivoting.
learning/directory contains further modules for various learning algorithms.
polytopedirectory contains further modules with code for best response polytopes.
This contains all the test files.
│ ├── discussion/
│ ├── how-to/
│ ├── index.rst
│ ├── reference/
│ └── tutorial/
contributing/directory contains the specific contributing documentation. Which itself is written using Diataxis [Procida2021].
discussion/directory contains source files for the discussion described at [Procida2021] as: “explanation is discussion that clarifies and illuminates a particular topic.”
reference/directory contains source files for the reference described at [Procida2021] as: “reference guides are technical descriptions of the machinery and how to operate it.”
how-to/directory contains source files for the how to guides described at [Procida2021] as: “how-to guides are directions that take the reader through the steps required to solve a real-world problem”
tutorial/directory contains source files for the tutorial described at [Procida2021] as: “tutorials are lessons that take the reader by the hand through a series of steps to complete a project of some kind.”
Makes a note of different changes in versions of Nashpy.
Contains information for citing Nashpy.
Contains the license.
Contains the first entry point documentation to the Nashpy project.
Contains all the build instructions for packaging Nashpy and is used by flit.
This includes configuration settings for the online service that hosts the documentation read the docs.
Contains some configuration instructions for testing.
Contains the instructions for the test runner
The Game class¶
nashpy.Game class is an umbrella class that creates an object
oriented interface to all functionality of Nashpy as methods on a game.