Skip to main content

A simulation package for Floor Field Model

Project description

FloorFieldModel

概要

このパッケージの概要

FloorFieldModelは、既存の Floor Field モデルを Python 初学者でも簡単に使えるように簡素化したパッケージです。歩行者の動きや避難シミュレーションを手軽に行うためのフレームワークを提供します。

FloorFieldModel とは

作成中

機能

  • 簡単に環境設定: ランダムマップやカスタムマップを利用可能。
  • 距離空間の作成: マップから距離情報を生成し、シミュレーションに利用。
  • パラメータの柔軟な設定: 歩行者数、流入、移動方法、モデルパラメータの設定が可能。
  • 可視化ツール: シミュレーション結果を可視化して、歩行者の動きや混雑を確認できる。
  • カスタマイズ可能なシミュレーション: 独自のパラメータを設定して、シミュレーションを実行可能。

インストール

パッケージをインストールするには、以下のpipコマンドを使用します。

pip install FloorFieldModel

もしくは、リポジトリをクローンして手動でインストールできます。

git clone https://github.com/SoraKurihara/FloorFieldModel.git
cd FloorFieldModel
pip install .

使用方法

このパッケージを使用する際、作業ディレクトリに 4 つのディレクトリ(map, data, output, SFF)が作成されます。まず、適切な作業ディレクトリを準備してください。

作業ディレクトリの作成例

mkdir my_simulation_project
cd my_simulation_project

その後、以下の手順でシミュレーションを実行してください。

import FloorFieldModel as FFM

ffm = FFM.FloorFieldModel(Map="random", SFF=None, method="L2")
ffm.params(N=0, inflow=None, k_S=3, k_D=1, d="Neumann")
ffm.run(steps=100)
ffm.plot(footprints=False)

カスタマイズされたシミュレーション

次のように、マップやパラメータをカスタマイズしてシミュレーションを実行できます。

ffm = FFM.FloorFieldModel(Map="my_custom_map.npy", SFF=None, method="Linf")
ffm.params(N=100, inflow=50, k_S=10, k_D=1, d="Moore")
ffm.run(steps=1000)
ffm.plot(footprints=True)

examplesディレクトリには、以下のような事前定義されたシミュレーションシナリオがあります。

  • map ディレクトリ: あらかじめ用意されたシミュレーションシナリオが含まれています。
  • output ディレクトリ: 実際に作成されたシミュレーション結果の mp4 ファイルが保存されています。

これらのディレクトリを参照して、シミュレーションの実行例や結果を確認することができます。

貢献

貢献は大歓迎です!問題やプルリクエスト、または改善提案があればお気軽に提出してください。

ライセンス

このプロジェクトは MIT ライセンスの下でライセンスされています。詳細はLICENSEファイルをご確認ください。

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

floorfieldmodel-0.1.5.tar.gz (10.8 kB view details)

Uploaded Source

Built Distribution

FloorFieldModel-0.1.5-py3-none-any.whl (13.6 kB view details)

Uploaded Python 3

File details

Details for the file floorfieldmodel-0.1.5.tar.gz.

File metadata

  • Download URL: floorfieldmodel-0.1.5.tar.gz
  • Upload date:
  • Size: 10.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.4

File hashes

Hashes for floorfieldmodel-0.1.5.tar.gz
Algorithm Hash digest
SHA256 266de2cccd2f099d842e523db0e47826d8b89ab7d5bd205728c3bf5a1c851f70
MD5 5b78f8b6da43d64eaa908f5e7cf93722
BLAKE2b-256 fbc30d2475f5122ca1a83ab21dd045724cf3380deba9a57b21b91f93f0f49551

See more details on using hashes here.

File details

Details for the file FloorFieldModel-0.1.5-py3-none-any.whl.

File metadata

File hashes

Hashes for FloorFieldModel-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 7d598cde9092c30c0aa93332ec069ce2ef8f8875be6664741c772e7afd7849db
MD5 f6eb4d1c83455d0d6d5b0b0a8f4feae5
BLAKE2b-256 94d25dfeec8cd83958a3a6e3b8325cd9538d6319751801389ff7dee93ab064f8

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page