search

SageMathOER-CCC / sage-discrete-math

An open textbook for Discrete Mathematics with SageMath, as taught at the City Colleges of Chicago
https://sagemathoer-ccc.github.io/sage-discrete-math/
Other
2 stars 2 forks source link
discrete-mathematics education oer open-source sagemath

readme

Discrete Math with SageMath

Chicago City Colleges Open Educational Resource

Welcome to our interactive online textbook for learning Discrete Mathematics with SageMath. View the most recent version of the textbook at https://sagemathoer-ccc.github.io/sage-discrete-math/Discrete-Math-with-SageMath.html

Empowering mathematicians and computer scientists with open-source tools

We are developing essential resources for students to use mathematical software effectively. Our goal is to streamline the learning process with SageMath. This approach helps students focus more on mathematics and reduces the friction of learning how to code. Our resources are designed for all math students, regardless of programming experience.

What is SageMath?

SageMath is a free, open-source mathematics software system based on Python. It integrates well-known open-source packages that include NumPy, SciPy, matplotlib, Sympy, Maxima, GAP, FLINT, R, and many others. SageMath is fulfilling the need for a robust and free alternative to proprietary software like Magma, Maple, Mathematica, and Matlab.

Why Discrete Mathematics with SageMath?

Our first textbook focuses on discrete mathematics. SageMath allows students to explore and visualize complex concepts, boosting their understanding and skills in this essential subject.

How to Contribute

We invite you to contribute to our project.

Submitting an Issue

If you encounter any bugs or typos, have suggestions for improvements, or have questions about the project, please submit an issue. Here's how:

  1. Navigate to the Issues tab in the GitHub repository.
  2. Click on the "New Issue" button.
  3. Fill in the title and describe the issue or suggestion in detail.
  4. Submit the issue.

Clone the Repository and Create a Branch

To contribute to the codebase or content, you'll need to clone the repository and create a feature branch to work on your changes:

  1. Visit the GitHub repository.
  2. Clone the repository.
  3. Create a feature branch with a short descriptive name.
  4. Make your changes in the branch.

Setting Up a Codespace

GitHub Codespaces allows you to develop in a cloud-based development environment. To set up a codespace in a development container for this project:

  1. Go to the "Code" tab of your cloned repository.
  2. Click the green "Code" button, then select the option to create a new codespace.
  3. GitHub will prepare your codespace with the project's development environment.
  4. Alternatively, you can clone the repository to your local machine and set up the development environment with a development container.

How to Make Changes

After setting up a codespace or cloning the repository to your local machine, you can start making changes to the project. PreTeXt uses XML to structure the content and SageMath for interactive code cells. You can learn more about PreTeXt here.

You can refer to an overview of features and syntax in the PreTeXt documentation.

The quick reference is also helpful.

After making changes, open a terminal and run the following command to build the HTML for the project.

pretext build

The build command will inform you of any errors in the project. View the project in your browser with the following command:

pretext view

To generate the pdf version locally (saved under /output/print/main.pdf)

pretext build print

Note that LaTeX engine and all font dependencies would need to be installed -instructions varies per OS. Alternatively, .devcontainer.json is configured with the necessary dependencies to build the pdf version.

If you are happy with your changes, you can commit them to your branch and submit a pull request.

Submitting a Pull Request

After making your changes in the feature branch, you're ready to submit a pull request for review:

  1. Go to the GitHub repository and select the option to make a pull request for your feature branch.
  2. Ensure that the base repository and branch are correct.
  3. Fill in a clear title and description for your changes.
  4. Optionally, link the pull request to an issue.
  5. Submit the pull request.

The project maintainers will review your pull request and may request changes or merge it into the main project. Your contributions are appreciated and crucial in making this resource more comprehensive and valuable for math education.