Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/singularitti/toyhamiltonians.jl

Some toy Hamiltonians
https://github.com/singularitti/toyhamiltonians.jl

computational-physics hamiltonian julia-package linear-algebra materials-science statistics

Last synced: 1 day ago
JSON representation

Some toy Hamiltonians

Host: GitHub
URL: https://github.com/singularitti/toyhamiltonians.jl
Owner: singularitti
License: mit
Created: 2024-10-11T05:57:19.000Z (27 days ago)
Default Branch: main
Last Pushed: 2024-11-01T09:04:40.000Z (6 days ago)
Last Synced: 2024-11-01T10:17:24.499Z (6 days ago)
Topics: computational-physics, hamiltonian, julia-package, linear-algebra, materials-science, statistics
Language: Julia
Homepage: https://singularitti.github.io/ToyHamiltonians.jl/
Size: 302 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # ToyHamiltonians

| **Documentation** | [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://singularitti.github.io/ToyHamiltonians.jl/stable/) [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://singularitti.github.io/ToyHamiltonians.jl/dev/)                                                                                                                                                                                                                                                                                                 |

| :---------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

| **Build Status**  | [![Build Status](https://github.com/singularitti/ToyHamiltonians.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/singularitti/ToyHamiltonians.jl/actions/workflows/CI.yml?query=branch%3Amain) [![Build Status](https://ci.appveyor.com/api/projects/status/github/singularitti/ToyHamiltonians.jl?svg=true)](https://ci.appveyor.com/project/singularitti/ToyHamiltonians-jl)[![Build Status](https://api.cirrus-ci.com/github/singularitti/ToyHamiltonians.jl.svg)](https://cirrus-ci.com/github/singularitti/ToyHamiltonians.jl) |

|   **Coverage**    | [![Coverage](https://github.com/singularitti/ToyHamiltonians.jl/badges/main/coverage.svg)](https://github.com/singularitti/ToyHamiltonians.jl/commits/main) [![Coverage](https://codecov.io/gh/singularitti/ToyHamiltonians.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/singularitti/ToyHamiltonians.jl)                                                                                                                                                                                                                |

|    **Others**     | [![Code Style: Blue](https://img.shields.io/badge/code%20style-blue-4495d1.svg)](https://github.com/invenia/BlueStyle) [![License](https://img.shields.io/github/license/singularitti/ToyHamiltonians.jl)](https://github.com/singularitti/ToyHamiltonians.jl/blob/main/LICENSE)                                                                                                                                                                                                                                                   |

The code, which is [hosted on GitHub](https://github.com/singularitti/ToyHamiltonians.jl), is tested

using various continuous integration services for its validity.

This repository is created and maintained by

[@singularitti](https://github.com/singularitti), and contributions are highly welcome.

## Package features

## Installation

The package can be installed with the Julia package manager.

From [the Julia REPL](https://docs.julialang.org/en/v1/stdlib/REPL/), type `]` to enter

the [Pkg mode](https://docs.julialang.org/en/v1/stdlib/REPL/#Pkg-mode) and run:

```julia-repl

pkg> add ToyHamiltonians

```

Or, equivalently, via [`Pkg.jl`](https://pkgdocs.julialang.org/v1/):

```julia

julia> import Pkg; Pkg.add("ToyHamiltonians")

```

## Documentation

- [**STABLE**](https://singularitti.github.io/ToyHamiltonians.jl/stable/) — **documentation of the most recently tagged version.**

- [**DEV**](https://singularitti.github.io/ToyHamiltonians.jl/dev/) — _documentation of the in-development version._

## Project status

The package is developed for and tested against Julia `v1.6` and above on Linux, macOS, and

Windows.

## Questions and contributions

You can post usage questions on

[our discussion page](https://github.com/singularitti/ToyHamiltonians.jl/discussions).

We welcome contributions, feature requests, and suggestions. If you encounter any problems,

please open an [issue](https://github.com/singularitti/ToyHamiltonians.jl/issues).

The [Contributing](@ref) page has

a few guidelines that should be followed when opening pull requests and contributing code.