Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update installation.rst #17

Merged
merged 4 commits into from
Jun 22, 2024
Merged

docs: update installation.rst #17

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
065aa1d
docs: update installation.rst
leocov-dev Jun 22, 2024
d592f49
docs: mention discord server
leocov-dev Jun 22, 2024
510d5bf
docs: mention example
leocov-dev Jun 22, 2024
2600409
docs: spelling
leocov-dev Jun 22, 2024
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
45 changes: 24 additions & 21 deletions docs/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,34 +3,40 @@ Installation

Getting Python
--------------
Cedar-solve is written for Python 3.7 or later (and therefore runs on almost any platform) and should
Cedar-solve is written for Python 3.8 or later (and therefore runs on almost any platform) and should
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this was changed due to math.comb not existing in 3.7, the pyproject.toml file specifies >=3.8

work with most modern Python 3 installations. There are many ways to get Python on your system.
Most easily, by going to `the python webiste <https://www.python.org/>`_ and selecting your
Most easily, by going to `the python website <https://www.python.org/>`_ and selecting your
platform. On many operating systems Python is installed by default, but this can be a very old
version (often 2.7). Check if you have something installed by running ``python --version`` in a
command prompt or terminal window. You can also check ``python3 --version`` as it is sometimes
installed under this name. In the latter case, use ``python3`` and ``pip3`` in place of ``python``
and ``pip`` in these instructions.

Getting Cedar-solve
--------------
Cedar-solve is not available on PyPI (the Python Package Index) yet. Instead you need to provide
a link to or download the GitHub source code.
-------------------
Cedar-solve is available on PyPI (the Python Package Index). You may install it by::

pip install cedar-solve

Use PIP to download and install
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The easiest method is to let PIP download from GitHub and install. This will set up all
dependencies and make the package usable from anywhere.::
You can test that it works by invoking the database generator command::

pip install git+https://github.com/smroid/cedar-solve.git
tetra3-gen-db --help

You can test that it works by running the example provided in the GitHub repo.
Example
^^^^^^^
An `example <https://github.com/smroid/cedar-solve/blob/master/examples/test_tetra3.py>`_ is available on the GitHub repository showing some ways of working with the library.

Manually download source code
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Go to `the GitHub repository <https://github.com/smroid/cedar-solve>`_, click `Clone or Download` and
`Download ZIP` and extract the cedar-solve directory to where you want to use it. You can put this
directly in your Python project as a module and use, or see below for how to install it.
You have two options to manually download the source code.

1. Download the release of your choice by going to `GitHub Releases <https://github.com/smroid/cedar-solve/releases>`_
and downloading the `Source Code` archive in your preferred format.

2. Download the latest code from the `GitHub repository <https://github.com/smroid/cedar-solve>`_. Click `Clone or Download` and
`Download ZIP`

Afterward you can extract the cedar-solve directory to where you want to use it.

Use git to download and contribute to source code
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand All @@ -42,7 +48,7 @@ GitHib repository::

git clone "https://github.com/smroid/cedar-solve.git"

You should see the cedar-solve directory created for you with all neccessary files. Check the status of
You should see the cedar-solve directory created for you with all necessary files. Check the status of
your repository by typing::

cd cedar-solve
Expand Down Expand Up @@ -97,17 +103,14 @@ which should print out the solutions for the included test images.

You can run the automated test suite with this command (from the repository root dir)::

# run all tests
pytest

# skip slow tests
pytest -m "not slow"

Using cedar-solve as a module in your repository

A specific branch named `no_big_files` is available for practical inclusion as a git submodule
in your own repository. This does not include the default database and example images, making
it less than 1 MB. For a specific application you probably want a custom database anyway.
Comment on lines -107 to -109
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this branch isn't valid in the cedar-solve fork and we do include the default database in the python wheel. the download size is only 8.1MB for the wheel.


If problems arise
-----------------
Please get in touch by `filing an issue <https://github.com/smroid/cedar-solve/issues>`_.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While you're here, can you also add something like:

You can also join the Cedar Discord server at https://discord.gg/xbDrUyXP.


You can also join the `Cedar Discord <https://discord.gg/xbDrUyXP>`_ server.
Loading