https://github.com/cavenfish/yass.jl

Yet Another Simulation Suite (YASS.jl). A simulation suite for atomic simulations in Julia.

https://github.com/cavenfish/yass.jl

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (19.8%) to scientific vocabulary

Keywords

chemistry julia molecular-dynamics molecular-simulation physical-chemistry simulation-environment
Last synced: 5 months ago · JSON representation

Repository

Yet Another Simulation Suite (YASS.jl). A simulation suite for atomic simulations in Julia.

Basic Info
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
chemistry julia molecular-dynamics molecular-simulation physical-chemistry simulation-environment
Created almost 3 years ago · Last pushed 5 months ago
Metadata Files
Readme License

README.md

Logo

Yet Another Simulation Suite (YASS.jl)

YASS.jl is a modern, flexible atomic simulation suite written in Julia. It aims to provide:

  • 🎯 Simple, and intuitive API
  • ⚡ High performance native Julia implementation
  • 🔧 Easy extensibility for custom methods
  • 📦 Built-in potentials and analysis tools

Quick Start

```julia using YASS

Read molecule

water = readSystem("water.xyz")

Run 10ps NVE simulation

traj = run(TIP4Pf(), water, (0.0, 10.0ps), 1.0fs, NVE())

Analyze results

energies = [img.energy for img in traj.images] temperatures = [img.temp for img in traj.images] ```

Features

  • 🧪 Multiple molecular dynamics ensembles (NVE, NVT)
  • 🔬 Built-in analysis tools (RDF, VACF)
  • ⚛️ Geometry and cell optimizations
  • 📊 Common water models (TIP4P/2005f, SPC-F)
  • 💻 Easy-to-extend architecture
  • 🚄 High performance through Julia's native speed
  • 📝 Comprehensive documentation

Installation

julia using Pkg Pkg.add("https://github.com/Cavenfish/YASS.jl.git")

Contributing

We welcome contributions! Whether it's:

  • 🐛 Bug fixes
  • ✨ New features
  • 📚 Documentation improvements
  • 🧪 Additional test cases

If you find YASS.jl useful or just want to show support, please consider starring the repository!

Development Status

YASS.jl is currently in pre-release phase.

Here's what we're working on:

Roadmap

  • [x] Core functionality cleanup
  • [x] Comprehensive documentation
  • [ ] Example scripts and tutorials
  • [x] Test coverage >70%
  • [ ] Unitful.jl integration
  • [x] Chemfiles.jl integration

Upcoming Features

  • [ ] NPT ensemble simulations
  • [ ] Anharmonic vibrational analysis
  • [ ] Path integral molecular dynamics (PIMD)
  • [ ] Additional analysis tools

License

YASS.jl is MIT licensed. See LICENSE for details.

Citation

If you use YASS.jl in your research, please cite:

bibtex @misc{yass2023, author = {Brian C. Ferrari}, title = {YASS.jl: Yet Another Simulation Suite}, year = {2023}, publisher = {GitHub}, url = {https://github.com/Cavenfish/YASS.jl} }

Owner

  • Name: Brian C. Ferrari
  • Login: Cavenfish
  • Kind: user
  • Company: Chemistry PhD Candidate at Leiden University

GitHub Events

Total
  • Delete event: 4
  • Push event: 20
  • Pull request event: 1
  • Create event: 5
Last Year
  • Delete event: 4
  • Push event: 20
  • Pull request event: 1
  • Create event: 5

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 0
  • Total pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 1
Past Year
  • Issues: 0
  • Pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 1
Top Authors
Issue Authors
Pull Request Authors
  • github-actions[bot] (1)
Top Labels
Issue Labels
Pull Request Labels