Skip to content

Commit

Permalink
Update test and docs
Browse files Browse the repository at this point in the history
  • Loading branch information
toruseo committed Apr 30, 2024
1 parent 80176b9 commit 04a5307
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 10 deletions.
26 changes: 26 additions & 0 deletions .github/workflows/test-functions.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: Test functions

on:
push:
pull_request:
workflow_dispatch:
schedule:
- cron: '0 6 * * 1'

jobs:
verify-module:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Python 3.12
uses: actions/setup-python@v5
with:
python-version: "3.12"
- name: Install uxsim and dependencies
run: |
python -m pip install --upgrade pip
pip install .
- name: Install pytest other dependencies
run: pip install pytest pytest-rerunfailures pytest-xdist setuptools
- name: Run tests with pytest
run: pytest -n auto tests/test_other_functions.py --durations=0 -v
6 changes: 0 additions & 6 deletions README.jp.md
Original file line number Diff line number Diff line change
Expand Up @@ -200,14 +200,8 @@ results:

- `uxsim`ディレクトリ: UXsimパッケージ
- `uxsim/uxsim.py`: UXsim本体のコード
- `uxsim/analyzer.py`: 計算結果分析用コード
- `uxsim/utils.py`: 関連コード
- `uxsim/ResultGUIViewer/ResultGUIViewer.py`: 計算結果可視化用GUIサブモジュール
- `uxsim/OSMImporter/OSMImporter.py`: OpenStreetMapからのインポート用サブモジュール
- `uxsim/files`ディレクトリ: 関連ファイル
- `demos_and_examples`ディレクトリ: チュートリアルや使用例
- `dat`ディレクトリ: サンプルシナリオファイル
- `tests``.github`ディレクトリ: 開発用ファイル

## 使用条件・ライセンス

Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -197,8 +197,8 @@ UXsim is released under the MIT License. You are free to use it as long as the s

When publishing works based on UXsim, please cite:

- Toru Seo. Macroscopic Traffic Flow Simulation: Fundamental Mathematical Theory and Python Implementation. Corona Publishing Co., Ltd., 2023.
- Toru Seo. UXsim: An open source macroscopic and mesoscopic traffic simulator in Python-a technical overview. arXiv preprint arXiv: 2309.17114, 2023
- Toru Seo. [Macroscopic Traffic Flow Simulation: Fundamental Mathematical Theory and Python Implementation](https://toruseo.github.io/misc/MacroTrafficSim_English_summary.pdf). Corona Publishing Co., Ltd., 2023.
- Toru Seo. [UXsim: An open source macroscopic and mesoscopic traffic simulator in Python-a technical overview](http://dx.doi.org/10.48550/arXiv.2309.17114). arXiv preprint arXiv: 2309.17114, 2023

## Contributing and Discussion

Expand Down
3 changes: 1 addition & 2 deletions tests/test_verification_taxi.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
"""
This script verifies whether UXsim outputs plausible solutions for exceptional or uncommon situations.
The behavior of UXsim may be updated in the future.
This script verifies whether UXsim outputs reasonable solutions with taxis.
"""

import pytest
Expand Down

0 comments on commit 04a5307

Please sign in to comment.