{"id":23832000,"url":"https://github.com/csdms/bmi-example-pynetlogo","last_synced_at":"2026-06-24T05:32:06.887Z","repository":{"id":206297613,"uuid":"716248021","full_name":"csdms/bmi-example-pynetlogo","owner":"csdms","description":"An example of wrapping a model written in NetLogo with a Python BMI ","archived":false,"fork":false,"pushed_at":"2025-02-18T21:35:34.000Z","size":86,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-09-10T16:56:05.052Z","etag":null,"topics":["bmi","csdms","netlogo","python"],"latest_commit_sha":null,"homepage":"https://bmi.csdms.io","language":"NetLogo","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/csdms.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2023-11-08T18:34:45.000Z","updated_at":"2025-02-18T21:35:32.000Z","dependencies_parsed_at":"2023-12-16T05:42:41.652Z","dependency_job_id":"5266d2b5-bec8-4df9-9d56-8cde08018fa2","html_url":"https://github.com/csdms/bmi-example-pynetlogo","commit_stats":{"total_commits":42,"total_committers":1,"mean_commits":42.0,"dds":0.0,"last_synced_commit":"c74ad22c4e4ac0228c53e1f313a092afbb4b0e51"},"previous_names":["csdms/bmi-example-pynetlogo"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/csdms/bmi-example-pynetlogo","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/csdms%2Fbmi-example-pynetlogo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/csdms%2Fbmi-example-pynetlogo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/csdms%2Fbmi-example-pynetlogo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/csdms%2Fbmi-example-pynetlogo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/csdms","download_url":"https://codeload.github.com/csdms/bmi-example-pynetlogo/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/csdms%2Fbmi-example-pynetlogo/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34719097,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-24T02:00:07.484Z","response_time":106,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bmi","csdms","netlogo","python"],"created_at":"2025-01-02T14:16:53.823Z","updated_at":"2026-06-24T05:32:06.860Z","avatar_url":"https://github.com/csdms.png","language":"NetLogo","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Basic Model Interface](https://img.shields.io/badge/CSDMS-Basic%20Model%20Interface-green.svg)](https://bmi.readthedocs.io/)\n[![Test](https://github.com/csdms/bmi-example-pynetlogo/actions/workflows/test.yml/badge.svg)](https://github.com/csdms/bmi-example-pynetlogo/actions/workflows/test.yml)\n\n# bmi-example-pynetlogo\n\nAn example of using the\n[Python bindings](https://github.com/csdms/bmi-python)\nfor the CSDMS\n[Basic Model Interface](https://bmi.readthedocs.io) (BMI)\nto wrap a model written in [NetLogo](https://ccl.northwestern.edu/netlogo/).\n\n## Overview\n\nThis is an example of implementing a BMI for a simple model of temperature diffusion\non a uniform rectangular plate\nwith Dirichlet boundary conditions.\nThe model, [HeatDiffusion](https://ccl.northwestern.edu/netlogo/models/HeatDiffusion),\nis written in NetLogo,\nand is a part of the standard NetLogo distribution.\n\nThis repository is organized with the following directories:\n\n\u003cdl\u003e\n    \u003cdt\u003eheat\u003c/dt\u003e\n        \u003cdd\u003eSource for the model and a BMI implementation for the model\u003c/dd\u003e\n    \u003cdt\u003eexamples\u003c/dt\u003e\n        \u003cdd\u003ePython scripts and Jupyter Notebooks that demonstrate how to run the model standalone and through its BMI\u003c/dd\u003e\n    \u003cdt\u003etests\u003c/dt\u003e\n        \u003cdd\u003eTests that cover the BMI of the model\u003c/dd\u003e\n\u003c/dl\u003e\n\n## Build/Install\n\nThis example can be built and installed on Linux, macOS, and Windows.\n\n**Prerequisites:**\n\n* Java Runtime Environment (JRE). NetLogo is build on Java, and it needs a JRE to run.\n* NetLogo. Instructions for downloading and installing NetLogo can be found [here](https://ccl.northwestern.edu/netlogo/download.shtml). NetLogo 6.1.1 was used to build, test, and run this example.\n* Python BMI mappings. Follow the [build and install directions](https://github.com/csdms/bmi-python#install) given in that repository. You can choose to install them from source, or through `pip` or `conda`.\n* PyNetLogo and Jpype. These are the key software packages that allow communication between NetLogo and Python.\n\nWe recommend setting up a virtual environment--e.g., through `venv` or `conda`--to install the packages required for this example.\nFor `conda`,\nwe've included an environment file.\n```\nconda env create --file environment.yml\n```\nThis creates the *logo* environment,\nwhich you can activate to have access to all the dependent packages needed to build and use this example.\n\nInstall the example with `pip`.\n```\npip install -e .\n```\n\n### Note on Java install location\n\nJpype tries to guess where Java is installed.\nIf Java is installed in a non-standard location,\nset the `JAVA_HOME` environment variable.\nAs an example,\nI installed Java through Homebrew on my Mac,\nso I set `JAVA_HOME` to its install location:\n```bash\nexport JAVA_HOME=/opt/homebrew/opt/openjdk\n```\n\n## Use\n\nTry the example notebooks and scripts in the [examples](./examples/) directory. \n\n## Acknowledgments\n\nThe model of temperature diffusion used in this example.\n\n\u003e Wilensky, U. (1998). NetLogo Heat Diffusion model. http://ccl.northwestern.edu/netlogo/models/HeatDiffusion. Center for Connected Learning and Computer-Based Modeling, Northwestern University, Evanston, IL.\n\nThe NetLogo software.\n\n\u003e Wilensky, U. (1999). NetLogo. http://ccl.northwestern.edu/netlogo/. Center for Connected Learning and Computer-Based Modeling, Northwestern University, Evanston, IL.\n\nCSDMS is supported with funding from the U.S. National Science Foundation.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcsdms%2Fbmi-example-pynetlogo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcsdms%2Fbmi-example-pynetlogo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcsdms%2Fbmi-example-pynetlogo/lists"}