Referans

Referans bölümü, dynlib içerisinde tanımlı yerleşik modelleri listeler. Kaynak kodlarına sahipseniz bu referansı tools/gen_model_docs.py betiğini çalıştırarak yerel olarak üretebilirsiniz.

Yerleşik modeller

Yerleşik modeller kaynak kodlarında src/dynlib/models/{map,ode} kalsörleri içerisinde tanımlı olup builtin URI etiketi ile kullanılabilir. Hangi yerleşik modelin hangi eşitliklere sahip olduğunu print_equations() metodu yardımıyla çalışma anında da öğrenebilirsiniz.

• Yerleşik model genel bakışı — yerleşik map ve ODE modellerinin TOML DSL dosyalarını inceleyin.

Dökümantasyonu lokal olarak üretme

• Dmkümantasyon için mkdocs kullanılmıştır. Eğer lokal olarak bu dökümasnyonu kendiniz oluşturmak isterseniz aşağıdaki adımları takip edin:

• MkDocs ve eklentilerini kurun (sanal ortam ile):

  pip install mkdocs mkdocs-material mkdocs-literate-nav "mkdocstrings[python]" mkdocs-static-i18n
  

• İlave Markdown eklentilerini kurun:

  pip install pymdown-extensions
  

• Proje klasörü üzerinden aşağıdaki komutları çalıştırın:

  mkdocs serve
  

  Or build them:

  mkdocs build
  

• Otomatik olarak üretilen dökümantasyonu üretmek için aşağıdaki komutu çalıştırın:

  python tools/gen_model_docs.py
  

Üretilecek olan dökümantasyon site/ klasörü içinde olacaktır.