https://github.com/mineralscloud/millerindices.jl
A notation system in crystallography for lattice planes in crystal (Bravais) lattices
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
-
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (9.2%) to scientific vocabulary
Keywords
Keywords from Contributors
Repository
A notation system in crystallography for lattice planes in crystal (Bravais) lattices
Basic Info
- Host: GitHub
- Owner: MineralsCloud
- License: mit
- Language: Julia
- Default Branch: main
- Homepage: https://mineralscloud.github.io/MillerIndices.jl/
- Size: 574 KB
Statistics
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 1
- Releases: 3
Topics
Metadata Files
README.md
MillerIndices
| Documentation | Build Status | Others |
| :--------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------: |
| 
| 
| 
|
MillerIndices.jl is a Julia package that provides a convenient way to handle Miller
indices and Miller–Bravais indices in crystallography.
The code, which is hosted on GitHub, is tested using various continuous integration services for its validity.
This repository is created and maintained by @singularitti, and contributions are highly welcome.
Package features
- Representation of indices:
Miller: Represents the Miller indices in real space (crystal directions).ReciprocalMiller: Represents the Miller indices in reciprocal space (planes).MillerBravais: Represents the Miller–Bravais indices in real space (crystal directions).ReciprocalMillerBravais: Represents the Miller–Bravais indices in reciprocal space (planes).
- Macro for easy generation:
julia
m"[-1, 0, 1]" # Miller
m"<2, -1, -1, 3>" # MillerBravais
m"(-1, 0, 1)" # ReciprocalMiller
m"(1, 0, -1, 0)" # ReciprocalMillerBravais
List equivalent directions/planes
Conversion between Miller and Miller-Bravais representations
Calculate angles between indices
Interplanar spacing calculation
Installation
The package can be installed with the Julia package manager.
From the Julia REPL, type ] to enter
the Pkg mode and run:
julia-repl
pkg> add MillerIndices
Or, equivalently, via Pkg.jl:
julia
julia> import Pkg; Pkg.add("MillerIndices")
Documentation
- STABLE — documentation of the most recently tagged version.
- 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.
We welcome contributions, feature requests, and suggestions. If you encounter any problems, please open an issue. The Contributing page has a few guidelines that should be followed when opening pull requests and contributing code.
Owner
- Name: Minerals Cloud
- Login: MineralsCloud
- Kind: organization
- Email: mineralscloudcu@gmail.com
- Location: Columbia University, New York, NY, USA
- Website: https://mineralscloud.github.io/
- Twitter: MineralsCloud
- Repositories: 39
- Profile: https://github.com/MineralsCloud
Investigates minerals in the cloud
GitHub Events
Total
- Delete event: 1
- Push event: 2
- Pull request event: 2
- Create event: 2
Last Year
- Delete event: 1
- Push event: 2
- Pull request event: 2
- Create event: 2
Committers
Last synced: about 1 year ago
Top Committers
| Name | Commits | |
|---|---|---|
| singularitti | s****i@o****m | 66 |
| dependabot[bot] | 4****] | 8 |
| CompatHelper Julia | c****y@j****g | 5 |
| github-actions[bot] | 4****] | 3 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 10 months ago
All Time
- Total issues: 1
- Total pull requests: 18
- Average time to close issues: less than a minute
- Average time to close pull requests: 3 days
- Total issue authors: 1
- Total pull request authors: 3
- Average comments per issue: 3.0
- Average comments per pull request: 0.17
- Merged pull requests: 18
- Bot issues: 0
- Bot pull requests: 13
Past Year
- Issues: 0
- Pull requests: 1
- Average time to close issues: N/A
- Average time to close pull requests: 20 days
- Issue authors: 0
- Pull request authors: 1
- Average comments per issue: 0
- Average comments per pull request: 0.0
- Merged pull requests: 1
- Bot issues: 0
- Bot pull requests: 1
Top Authors
Issue Authors
- JuliaTagBot (1)
Pull Request Authors
- dependabot[bot] (11)
- singularitti (5)
- github-actions[bot] (5)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- julia 27 total
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 3
juliahub.com: MillerIndices
A notation system in crystallography for lattice planes in crystal (Bravais) lattices
- Homepage: https://mineralscloud.github.io/MillerIndices.jl/
- Documentation: https://docs.juliahub.com/General/MillerIndices/stable/
- License: MIT
-
Latest release: 0.3.0
published over 2 years ago
Rankings
Dependencies
- actions/checkout v3 composite
- codecov/codecov-action v3 composite
- julia-actions/cache v1 composite
- julia-actions/julia-buildpkg v1 composite
- julia-actions/julia-docdeploy v1 composite
- julia-actions/julia-processcoverage v1 composite
- julia-actions/julia-runtest v1 composite
- julia-actions/setup-julia v1 composite
- JuliaRegistries/TagBot v1 composite
- julia-actions/RegisterAction latest composite