{"id":21040727,"url":"https://github.com/owlas/magpy","last_synced_at":"2025-05-15T16:33:26.505Z","repository":{"id":92962369,"uuid":"76475957","full_name":"owlas/magpy","owner":"owlas","description":"C++ accelerated python module for simulating magnetic nanostructures","archived":false,"fork":false,"pushed_at":"2018-02-07T10:34:13.000Z","size":3378,"stargazers_count":4,"open_issues_count":9,"forks_count":3,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-04-03T11:38:58.559Z","etag":null,"topics":["cpp11","magnetism","parallel","python3","scientific-computing","stochastic-differential-equations"],"latest_commit_sha":null,"homepage":"https://magpy.readthedocs.io","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/owlas.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,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-12-14T16:14:05.000Z","updated_at":"2025-02-03T21:33:20.000Z","dependencies_parsed_at":"2023-03-13T17:24:11.510Z","dependency_job_id":null,"html_url":"https://github.com/owlas/magpy","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/owlas%2Fmagpy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/owlas%2Fmagpy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/owlas%2Fmagpy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/owlas%2Fmagpy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/owlas","download_url":"https://codeload.github.com/owlas/magpy/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254377465,"owners_count":22061142,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["cpp11","magnetism","parallel","python3","scientific-computing","stochastic-differential-equations"],"created_at":"2024-11-19T13:47:48.875Z","updated_at":"2025-05-15T16:33:26.497Z","avatar_url":"https://github.com/owlas.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"# \u003cimg src=\"./img/magpy.png\" height=\"80px\" alt=\"magpy\"\u003e\n\nmagpy is a C++ accelerated python package for simulating systems of\nmagnetic nanoparticles.\n\n**Current status**\n\n[![CircleCI](https://circleci.com/gh/owlas/magpy.svg?style=svg)](https://circleci.com/gh/owlas/magpy)\n[![Documentation Status](https://readthedocs.org/projects/magpy/badge/?version=latest)](http://magpy.readthedocs.io/en/latest/?badge=latest)\n[![Stories in Ready](https://badge.waffle.io/owlas/magpy.png?label=ready\u0026title=Ready)](https://waffle.io/owlas/magpy)\n[![conda-version](https://anaconda.org/owlas/magpy/badges/version.svg)](https://anaconda.org/owlas/magpy/)\n![conda-license](https://anaconda.org/owlas/magpy/badges/license.svg)\n[![conda-downloads](https://anaconda.org/owlas/magpy/badges/downloads.svg)](https://anaconda.org/owlas/magpy/)\n[![conda-link](https://anaconda.org/owlas/magpy/badges/installer/conda.svg)](https://anaconda.org/owlas/magpy/)\n[![DOI](https://zenodo.org/badge/76475957.svg)](https://zenodo.org/badge/latestdoi/76475957)\n\n**Features**\n\n - C++ accelerated time-integration\n - Stochastic Landau-Lifshitz-Gilbert equation\n - Explicit Heun scheme integration\n - Implicit Midpoint method\n - Parallelism at the highest level. Use the power of embarrassingly\n   parallel!\n - Thermal activation model for single particles\n - Energy dissipation and SAR calculations\n\nJoin the chat at:\n\n[![Join the chat at https://gitter.im/magpy-users/Lobby](https://badges.gitter.im/magpy-users/Lobby.svg)](https://gitter.im/magpy-users/Lobby?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge\u0026utm_content=badge)\n\n## Documentation\n\nGetting started guides, example code, tutorials, and the API documentation are\navailable at http://magpy.readthedocs.io\n\nThey can also be built locally with sphinx. Requirements are found in the `enviornment.yml` file:\n\n``` shell\n    $ cd docs\n    $ cat environment.yml\n    $ make html\n```\n\n## Installation\n\nDetailed instructions can be found at http://magpy.readthedocs.io\n\n## Tests\n\n### Unit tests\n\nUnit tests exist for the C++ code (gtest) and python code (pytest).\n\nThe following code snippet will run the C++ unit tests with gtest.\n\n``` shell\n    $ cd /path/to/magpy/project\n    $ make run-tests\n```\n\nIn order to run the python unit tests:\n\n``` shell\n    $ cd /path/to/magpy/project\n    $ pytest -v magpy\n```\n\n### Numerical tests\n\nThe numerical tests check the stability of the numerical integrators:\n\n``` shell\n    $ cd /path/to/magpy/project\n    $ make test/convergence/run\n    $ cd test/convergence\n    $ chmod +x run\n    $ ./run\n```\n\nThis command will populate the directory `./test/convergence/output` with results.\nThe results are explained and visualised in `./docs/source/notebooks/convergence.ipynb`\n(also see [hosted docs](https://magpy.readthedocs.io))\n\n### Physics tests\n\nFor details see the docs in `./docs` or at [magpy.readthedocs.io](https://magpy.readthedocs.io)\n\nThe notebooks are validated using [nbval](https://github.com/computationalmodelling/nbval). Nbval\nreruns all the documentation notebooks and checks that there has been no change in output.\nThis is particularly important to check if you have updated interfaces or changed the code\nbase in anyway.\n\nThe notebooks take a long time to rerun and aren't included in the continuous integration testing.\n\n``` shell\n    $ cd /path/to/magpy/project\n    $ pytest --nbval-lax docs/source/notebooks\n```\n\n## Contributing\n\n - Open an issue\n - Make a pull request\n - Join us on gitter\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fowlas%2Fmagpy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fowlas%2Fmagpy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fowlas%2Fmagpy/lists"}