{"id":19706235,"url":"https://github.com/llnl/pylibrom","last_synced_at":"2025-04-29T16:33:11.761Z","repository":{"id":187107944,"uuid":"676322908","full_name":"LLNL/pylibROM","owner":"LLNL","description":"Python interface for libROM, library for reduced order models","archived":false,"fork":false,"pushed_at":"2025-02-05T18:20:00.000Z","size":9605,"stargazers_count":61,"open_issues_count":6,"forks_count":2,"subscribers_count":12,"default_branch":"main","last_synced_at":"2025-04-12T05:03:36.935Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://www.librom.net","language":"Python","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/LLNL.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}},"created_at":"2023-08-09T00:19:01.000Z","updated_at":"2025-03-22T15:13:17.000Z","dependencies_parsed_at":"2023-08-09T02:31:56.408Z","dependency_job_id":"c4e129cb-27c1-43f8-ac8c-017721bd10ae","html_url":"https://github.com/LLNL/pylibROM","commit_stats":null,"previous_names":["llnl/pylibrom"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LLNL%2FpylibROM","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LLNL%2FpylibROM/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LLNL%2FpylibROM/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LLNL%2FpylibROM/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LLNL","download_url":"https://codeload.github.com/LLNL/pylibROM/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251540489,"owners_count":21605911,"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":[],"created_at":"2024-11-11T21:34:42.514Z","updated_at":"2025-04-29T16:33:06.750Z","avatar_url":"https://github.com/LLNL.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# pylibROM\nPython Interface for LLNL libROM \n\n## Installation\n\n1. Pull repository and all sub-module dependencies:\n  ```\n  git clone --recurse-submodules https://github.com/llnl/pylibROM.git\n  ```\n\n2. Compile and build pylibROM (from top-level pylibROM repo):\n  ```\n  pip install ./\n  ```\n  To speed up the build if libROM has been compiled:\n  ```\n  pip install ./ --global-option=\"--librom_dir=/path/to/pre-installed-libROM\"\n  ```  \n  If you want to build static ScaLAPACK for libROM,\n  ```\n  pip install ./ --global-option=\"--install_scalapack\"\n  ```\n  \n3. Test python package (from top-level pylibROM repo):\n  ```\n  cd tests\n  pytest test_pyVector.py\n  ```\n\n### Using PyMFEM\n`pylibROM` is often used together with [`PyMFEM`](https://github.com/mfem/PyMFEM).\nCheck the repository for detailed instruction for `PyMFEM` installation.\nFor serial version of `PyMFEM`, the following simple `pip` command works:\n```\npip install mfem\n```\nFor parallel version, a manual installation is required:\n```\ngit clone https://github.com/mfem/PyMFEM.git\ncd PyMFEM\npython3 setup.py install --with-parallel --with-gslib\n```\nOn LC quartz, use `--user` flag:\n```\npython3 setup.py install --with-parallel --with-gslib --user\n```\nMake sure [`swig`](https://pypi.org/project/swig) is installed first. Also, the binary file must be located in `PATH` environment variable.\n\n### pylibROM-Jupyter Docker Container\n\nThis Docker container provides an environment with Jupyter Notebook for the pylibROM library. Follow the steps below to build the Docker image and run a Jupyter Notebook server.\n\n#### Build the Docker Image\n\nNavigate to the directory containing the Dockerfile:\n ```\ncd /path/to/folder/pylibROM/docker/jupyter\n ```\n\nNow, run the following command to build the Docker image:\n \n ```\ndocker build -t pylibrom-jupyter:latest .\n ```\n\nOnce the image is built, you can run a container and start a Jupyter Notebook server. Replace /path/to/host/folder with the absolute path to the local directory you want to mount inside the container for Jupyter notebooks: \n\n ```\ndocker run -p 8888:8888 -v /path/to/host/folder:/notebooks -w /notebooks pylibrom-jupyter:latest\n ```\n\n\n## License\npylibROM is distributed under the terms of the MIT license. All new contributions must be made under the MIT. See\n[LICENSE-MIT](https://github.com/LLNL/pylibROM/blob/main/LICENSE)\n\nLLNL Release Nubmer: LLNL-CODE- 852921\n\n\n## Authors\n- Michael Barrow (LLNL)\n- Siu Wun Cheung (LLNL)\n- Youngsoo Choi (LLNL)\n- \"Kevin\" Seung Whan Chung (LLNL)\n- Pravija Danda (TAMU)\n- Coleman Kendrick (LLNL)\n- Hardeep Sullan (LLNL)\n- Jian Tao (TAMU)\n- Henry Yu (LLNL)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fllnl%2Fpylibrom","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fllnl%2Fpylibrom","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fllnl%2Fpylibrom/lists"}