Generate knowledge graphs with interesting geometries, like lattices.
Generate knowledge graphs with interesting geometries, like lattices. Works on Python 3.9+ because it uses cool new features. Get out of that 2020 funk and install the most recent version of Python.
💪 Getting Started
See https://github.com/cthoyt/translational-toys for example usage to generate charts like
The most recent release can be installed from PyPI with:
$ pip install geometric_graphs
The most recent code and data can be installed directly from GitHub with:
$ pip install git+https://github.com/cthoyt/geometric-graphs.git
To install in development mode, use the following:
$ git clone git+https://github.com/cthoyt/geometric-graphs.git
$ cd geometric-graphs
$ pip install -e .
Contributions, whether filing an issue, making a pull request, or forking, are appreciated. See CONTRIBUTING.rst for more information on getting involved.
The code in this package is licensed under the MIT License.
🛠️ For Developers
See developer instrutions
The final section of the README is for if you want to get involved by making a code contribution.
After cloning the repository and installing
pip install tox, the unit tests in the
tests/ folder can be
run reproducibly with:
Additionally, these tests are automatically re-run with each commit in a GitHub Action.
📦 Making a Release
After installing the package in development mode and installing
pip install tox, the commands for making a new release are contained within the
tox.ini. Run the following from the shell:
$ tox -e finish
This script does the following:
- Uses BumpVersion to switch the version number in the
src/geometric_graphs/version.pyto not have the
- Packages the code in both a tar archive and a wheel
- Uploads to PyPI using
twine. Be sure to have a
.pypircfile configured to avoid the need for manual input at this step
- Push to GitHub. You'll need to make a release going with the commit where the version was bumped.
- Bump the version to the next patch. If you made big changes and want to bump the version by minor, you can
tox -e bumpversion minorafter.
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Hashes for geometric_graphs-0.0.3-py3-none-any.whl