gwsim: A Python package for generating Mock Data Challenge datasets for the gravitational-wave community.

0.3.0 - 2026-01-10

🚀 Features

• (cli) Support resource monitoring in gwsim simulate - (33f8af4)
• (cli) Add dry run mode to gwsim simulate - (6c720b8)
• (cli) Adding batch command - (c3ca09b)
• (cli) Updating batch command setup - (4b96a58)
• (monitor) Add log_summary method to ResourceMonitor - (caae7d1)
• Add atomic_writer to support atomic file writing - (8e6af93)
• Add ResourceMonitor for monitoring resource usage - (e937392)
• Add save_metrics method to ResourceMonitor - (a95e90b)

🐛 Bug Fixes

• (cli) Silencing duplicate-code warning - (7347090)
• (glitch) Correct frequency binning - (4c86570)
• (glitch) Correct frequency binning - (876ea50)
• Remove the unrecognized option suggestion-mode for pylint - (5a99a21)
• Fix: In save_metadata_with_external_state, create metadata directory if not exists - (f3b8128)

💼 Other

• Add psutil to dependencies - (adc1f41)
• [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci - (5244406)

📚 Documentation

• (cli) Create documentation for batch command - (dc3674c)
• (cli) Removing old documentation - (1810e53)
• Add a badge for bandit - (ebb9523)
• Change pul request to merge request in README.md - (296a2f7)
• Add the Zenodo DOI to README.md - (ef51da1)
• Update the documentation about the description of the dry-run mode - (6f7a227)
• Move contributing guide to the root directory - (b06c6cd)
• Copy CONTRIBUTING.md to docs directory - (c0bd814)
• Add security policy - (ac5876e)
• Copy SECURITY.md to docs directory - (d443af6)
• Add security policy to the documentation page - (8c6ca9c)
• Remove redundant phrase: "CLI interface" -> "CLI" - (a543f97)
• Fix the duplicate "export" in example - (b5fa915)
• Quote 1 day to avoid YAML/parser ambiguity - (993c5af)
• Remove redundant phrasing in feature list - (d975ca6)
• Update the badges in README.md - (2424fc9)
• Add the information about the release schedule - (b2900af)
• Update the GitLab links with the GitHub links - (b733ff1)
• Add missing inline comment for consistency - (05ff9be)
• Fix the code block indentation - (8f72fcc)
• Use subsection headers instead of bold texts - (1b946a9)
• Update the link to the documentation to the GitHub page - (2e798c7)
• Update the code of conduct - (8c2b20d)

🎨 Styling

• (cli) Add full stops to the help of gwsim simulate for the consistency of style - (1fb94ad)
• (monitor) Use formatted names for logging resource usage - (cf9f136)
• (test) Rename test_simulate.py to test_cli_simulate.py for style consistency - (368fb7d)
• Rename test_io.py to test_utils_io.py for consistency - (b5e8046)
• Update the tab space to 4 - (6d4c10d)
• Rename INDENT to indent for style consistency - (210bdf9)
• Change the tab width to 2 - (3207597)
• Update the tab width to 2 - (c769e2d)

🧪 Testing

• (cli) Add unit tests for the dry run mode - (4430d1c)
• (monitor) Add unit tests for ResourceMonitor - (d211d38)
• (monitor) Add unit tests for log_summary of ResourceMonitor - (d4b4212)
• (monitor) Add unit tests for ResourceMonitor.save_metrics - (1bd63f4)
• (monitor) Fix the unit tests due to the change of output in ResourceMonitor.log_summary - (efaf3a4)
• (utils) Add unit tests for atomic_writer - (df4efad)
• Update the comparison of cpu_percent to with mock_process.cpu_percent - (765e559)

⚙️ Miscellaneous Tasks

• (cli) Do not include none in the config files - (0ccd0d6)
• (monitor) Expose ResourceMonitor to the monitor package - (f96ec64)
• Downgrade prettier to v0.3.1 - (768aace)
• Revert to use 2 spaces for yaml files - (3f3a844)
• Revert to use 2 spaces for yaml files - (e4391c3)
• Add dependabot - (bf370ad)
• Add CI.yml - (5c57265)
• Add create_tag.yml for creating a tag - (127e586)
• Add documentation.yml - (9842a0d)
• Add draft_release.yml - (d40e0ee)
• Add publish_testpypi.yml - (aa4baaa)
• Add publish.yml - (3a95f92)
• Add release.yml - (a7a0f8e)
• Replace pylint completely with ruff - (9762315)
• Fix linting errors - (169635a)
• Update the version of black to 25.12.0 to match with that in .pre-commit-config.yaml - (2a24544)
• Update the args of pyupgrade to --py310-plus - (e93f103)
• Update project URLs in pyproject.toml - (c710159)
• Remove the GitLab CI pipeline file - (ba9faaf)
• Add CITATION.cff for the citation information - (685f524)
• Use python 3.12 for building the documentation - (a48f5ed)
• Update the format of the changelog - (03d2e62)
• Ignore the merge commit from PR - (d59d9f7)
• Add codecov token for uploading coverage data - (62d23ab)
• Remove the redundant README in src - (990fea4)
• Update license information - (adb7c46)
• Fix the permission to write security events - (e5daf4f)

Contributing: We welcome contributions! Please see our Contributing Guide for details.

Questions? Open an issue on GitHub or join our discussions.