Mesa 3.0.0__tar.gz → 3.0.0a0__tar.gz

mesa-3.0.0a0/.github/ISSUE_TEMPLATE/asking-help.md

@@ -0,0 +1,9 @@
+---
+name: Asking for help
+about: If you need help using Mesa, you should post in https://github.com/projectmesa/mesa/discussions
+---
+
+<!--
+    ATTENTION: Don't raise an issue here!
+    If you need help, ask in https://github.com/projectmesa/mesa/discussions
+-->

{mesa-3.0.0 → mesa-3.0.0a0}/.github/ISSUE_TEMPLATE/bug-report.md

@@ -11,8 +11,7 @@ about: Let us know if something is broken on Mesa
 <!-- A clear and concise description of what you expected to happen -->
 
 **To Reproduce**
-<!-- Steps to reproduce the bug, or a link to a project where the bug is visible
-Include a Minimal reproducible example: https://stackoverflow.com/help/minimal-reproducible-example -->
+<!-- Steps to reproduce the bug, or a link to a project where the bug is visible -->
 
 **Additional context**
 <!--

{mesa-3.0.0 → mesa-3.0.0a0}/.github/release.yml

@@ -19,9 +19,6 @@ changelog:
     - title: 🐛 Bugs fixed
       labels:
         - bug
-    - title: 🔍 Examples updated
-      labels:
-        - example
     - title: 📜 Documentation improvements
       labels:
         - docs

{mesa-3.0.0 → mesa-3.0.0a0}/.github/workflows/benchmarks.yml

@@ -25,7 +25,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
-          python-version: '3.13'
+          python-version: '3.12'
       - name: Add project directory to PYTHONPATH
         run: echo "PYTHONPATH=$PYTHONPATH:$(pwd)" >> $GITHUB_ENV
       - name: Install dependencies

{mesa-3.0.0 → mesa-3.0.0a0}/.github/workflows/build_lint.yml

@@ -31,10 +31,8 @@ jobs:
       fail-fast: False
       matrix:
         os: [windows, ubuntu, macos]
-        python-version: ["3.13"]
+        python-version: ["3.12"]
         include:
-          - os: ubuntu
-            python-version: "3.12"
           - os: ubuntu
             python-version: "3.11"
           - os: ubuntu
@@ -49,20 +47,17 @@ jobs:
       uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
-        allow-prereleases: true
         cache: 'pip'
     - name: Install uv
       run: pip install uv
-    - name: Install Mesa and dependencies
+    - name: Install Mesa
+      # See https://github.com/astral-sh/uv/issues/1945
       run: uv pip install --system .[dev]
     - name: Test with pytest
       run: pytest --durations=10 --cov=mesa tests/ --cov-report=xml
     - if: matrix.os == 'ubuntu'
       name: Codecov
       uses: codecov/codecov-action@v4
-      with:
-        fail_ci_if_error: true
-        token: ${{ secrets.CODECOV_TOKEN }}
 
   examples:
     runs-on: ubuntu-latest
@@ -71,13 +66,12 @@ jobs:
     - name: Set up Python
       uses: actions/setup-python@v5
       with:
-        python-version: "3.13"
-        allow-prereleases: true
+        python-version: "3.12"
         cache: 'pip'
     - name: Install uv
       run: pip install uv
     - name: Install Mesa
-      run: uv pip install --system .[examples]
+      run: uv pip install --system .[dev]
     - name: Checkout mesa-examples
       uses: actions/checkout@v4
       with:
@@ -86,4 +80,4 @@ jobs:
     - name: Test examples
       run: |
         cd mesa-examples
-        pytest -rA -Werror -Wdefault::FutureWarning test_examples.py
+        pytest test_examples.py

{mesa-3.0.0 → mesa-3.0.0a0}/.github/workflows/release.yml

@@ -32,8 +32,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
-          python-version: "3.13"
-          allow-prereleases: true
+          python-version: "3.12"
           cache: 'pip'
       - name: Install dependencies
         run: pip install -U pip hatch

{mesa-3.0.0 → mesa-3.0.0a0}/.gitignore

@@ -1,10 +1,6 @@
 # Benchmarking
 benchmarks/**/*.pickle
 
-# exampledocs
-docs/examples/*
-docs/example.md
-
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
@@ -19,8 +15,6 @@ __pycache__/
 .Python
 env/
 venv/
-pythonenv*/
-.venv/
 build/
 develop-eggs/
 dist/
@@ -89,6 +83,10 @@ target/
 .dmypy.json
 dmypy.json
 
+# pythonenv
+pythonenv*/
+
 # JS dependencies
 mesa/visualization/templates/external/
 mesa/visualization/templates/js/external/
+

{mesa-3.0.0 → mesa-3.0.0a0}/.pre-commit-config.yaml

@@ -4,7 +4,7 @@ ci:
 repos:
 - repo: https://github.com/astral-sh/ruff-pre-commit
   # Ruff version.
-  rev: v0.7.2
+  rev: v0.5.0
   hooks:
     # Run the linter.
     - id: ruff
@@ -14,12 +14,12 @@ repos:
     - id: ruff-format
       types_or: [ python, pyi, jupyter ]
 -   repo: https://github.com/asottile/pyupgrade
-    rev: v3.19.0
+    rev: v3.16.0
     hooks:
     -   id: pyupgrade
         args: [--py310-plus]
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v5.0.0  # Use the ref you want to point at
+    rev: v4.6.0  # Use the ref you want to point at
     hooks:
     -   id: trailing-whitespace
     -   id: check-toml

{mesa-3.0.0 → mesa-3.0.0a0}/.readthedocs.yml

@@ -1,5 +1,5 @@
 # Read the Docs configuration file
-# See https://docs.readthedocs.io/stable/config-file/v2.html for details
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
 
 # Required
 version: 2
@@ -13,9 +13,9 @@ formats:
   - pdf
 
 build:
-  os: ubuntu-lts-latest
+  os: "ubuntu-22.04"
   tools:
-    python: latest
+    python: "3"
 
 # Optionally set the version of Python and requirements required to build your docs
 python:

mesa-3.0.0a0/CONTRIBUTING.md

@@ -0,0 +1,110 @@
+# Contributing
+
+As an open source project, Mesa welcomes contributions of many forms, and from beginners to experts. If you are
+curious or just want to see what is happening, we post our development session agendas
+and development session notes on [Mesa discussions]. We also have a threaded discussion forum on [Matrix]
+for casual conversation.
+
+In no particular order, examples include:
+
+- Code patches
+- Bug reports and patch reviews
+- New features
+- Documentation improvements
+- Tutorials
+
+No contribution is too small. Although, contributions can be too big, so let's
+discuss via [Matrix] OR via [an issue].
+
+**To submit a contribution**
+
+- Create a ticket for the item that you are working on.
+- Fork the Mesa repository.
+- [Clone your repository] from Github to your machine.
+- Create a new branch in your fork: `git checkout -b BRANCH_NAME`
+- Run `git config pull.rebase true`. This prevents messy merge commits when updating your branch on top of Mesa main branch.
+- Install an editable version with developer requirements locally: `pip install -e ".[dev]"`
+- Edit the code. Save.
+- Git add the new files and files with changes: `git add FILE_NAME`
+- Git commit your changes with a meaningful message: `git commit -m "Fix issue X"`
+- If implementing a new feature, include some documentation in docs folder.
+- Make sure that your submission works with a few of the examples in the examples repository. If adding a new feature to mesa, please illustrate usage by implementing it in an example.
+- Make sure that your submission passes the [GH Actions build]. See "Testing and Standards below" to be able to run these locally.
+- Make sure that your code is formatted according to [the black] standard (you can do it via [pre-commit]).
+- Push your changes to your fork on Github: `git push origin NAME_OF_BRANCH`.
+- [Create a pull request].
+- Describe the change w/ ticket number(s) that the code fixes.
+- Format your commit message as per [Tim Pope's guideline].
+
+## Testing and Code Standards
+
+```{image} https://codecov.io/gh/projectmesa/mesa/branch/main/graph/badge.svg
+:target: https://codecov.io/gh/projectmesa/mesa
+```
+
+```{image} https://img.shields.io/badge/code%20style-black-000000.svg
+:target: https://github.com/psf/black
+```
+
+As part of our contribution process, we practice continuous integration and use GH Actions to help enforce best practices.
+
+If you're changing previous Mesa features, please make sure of the following:
+
+- Your changes pass the current tests.
+- Your changes pass our style standards.
+- Your changes don't break the models or your changes include updated models.
+- Additional features or rewrites of current features are accompanied by tests.
+- New features are demonstrated in a model, so folks can understand more easily.
+
+To ensure that your submission will not break the build, you will need to install Ruff and pytest.
+
+```bash
+pip install ruff pytest pytest-cov
+```
+
+We test by implementing simple models and through traditional unit tests in the tests/ folder. The following only covers unit tests coverage. Ensure that your test coverage has not gone down. If it has and you need help, we will offer advice on how to structure tests for the contribution.
+
+```bash
+py.test --cov=mesa tests/
+```
+
+With respect to code standards, we follow [PEP8] and the [Google Style Guide]. We use [ruff format] (a more performant alternative to `black`) as an automated code formatter. You can automatically format your code using [pre-commit], which will prevent `git commit` of unstyled code and will automatically apply black style so you can immediately re-run `git commit`. To set up pre-commit run the following commands:
+
+```bash
+pip install pre-commit
+pre-commit install
+```
+
+You should no longer have to worry about code formatting. If still in doubt you may run the following command. If the command generates errors, fix all errors that are returned.
+
+```bash
+ruff .
+```
+
+## Licensing
+
+The license of this project is located in [LICENSE].  By submitting a contribution to this project, you are agreeing that your contribution will be released under the terms of this license.
+
+## Special Thanks
+
+A special thanks to the following projects who offered inspiration for this contributing file.
+
+- [Django]
+- [18F's FOIA]
+- [18F's Midas]
+
+[18f's foia]: https://github.com/18F/foia-hub/blob/master/CONTRIBUTING.md
+[18f's midas]: https://github.com/18F/midas/blob/devel/CONTRIBUTING.md
+[an issue]: https://github.com/projectmesa/mesa/issues
+[black]: https://github.com/psf/black
+[clone your repository]: https://help.github.com/articles/cloning-a-repository/
+[create a pull request]: https://help.github.com/articles/creating-a-pull-request/
+[django]: https://github.com/django/django/blob/master/CONTRIBUTING.rst
+[gh actions build]: https://github.com/projectmesa/mesa/actions/workflows/build_lint.yml
+[google style guide]: https://google.github.io/styleguide/pyguide.html
+[license]: https://github.com/projectmesa/mesa/blob/main/LICENSE
+[matrix]: https://matrix.to/#/#project-mesa:matrix.org`
+[mesa discussions]: https://github.com/projectmesa/mesa/discussions
+[pep8]: https://www.python.org/dev/peps/pep-0008
+[pre-commit]: https://github.com/pre-commit/pre-commit
+[tim pope's guideline]: https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html