Data

Tools

Indexes

Applications

Experiments

Open Source Science

horace-euphonic-interface

Allows simulation of cuts in Matlab Horace using Euphonic

https://github.com/pace-neutrons/horace-euphonic-interface

Science Score: 44.0%

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

  • ✓
    CITATION.cff file
    Found 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 (6.0%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Allows simulation of cuts in Matlab Horace using Euphonic

Basic Info
  • Host: GitHub
  • Owner: pace-neutrons
  • License: gpl-3.0
  • Language: Python
  • Default Branch: master
  • Homepage:
  • Size: 1.68 MB
Statistics
  • Stars: 3
  • Watchers: 2
  • Forks: 0
  • Open Issues: 7
  • Releases: 11
Created over 6 years ago · Last pushed about 1 year ago
Metadata Files
Readme Changelog License Citation

README.rst 

=========================
horace-euphonic-interface
=========================

See the `docs `_.

For developers
==============

Test data
---------

Test data is in Matlab ``.mat`` format and generated here 
but is *stored in the ``euphonic_sqw_models`` repository*.

In case the code changes so as to invalidate the test data, you can 
generate it using ``runtests('test/EuphonicGenerateTestData.m')`` here.
Then copy the ``*.mat`` files in ``test/expected_output`` to the
``euphonic_sqw_models`` repository and commit it.

Since we include ``euphonic_sqw_models`` as a submodule here, it will then
include the test data which must be the same in both repository.

Euphonic minimum version
------------------------

The minimum require version of Euphonic is stored in the 
``min_requirements.txt`` file of ``euphonic_sqw_models`` (not here).
Like the test data, this is inherited by this repo as a submodule
and propagated further.

Owner

  • Name: pace-neutrons
  • Login: pace-neutrons
  • Kind: organization

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "If you have used Horace-Euphonic-Interface in your research, please cite it as below"
abstract: "Horace-Euphonic-Interface is a MATLAB Add-on to allow simulation of Horace cuts with Euphonic"
authors:
  - family-names: "Fair"
    given-names: "Rebecca L."
    orcid: https://orcid.org/0000-0002-0926-2942
  - family-names: "Le"
    given-names: "Manh D."
    orcid: https://orcid.org/0000-0003-3012-6053
title: "Horace-Euphonic-Interface"
doi: 10.5286/SOFTWARE/HORACEEUPHONICINTERFACE
version: 1.1.0
date-released: 2023-02-16
license: GPL-3.0-only
repository-code: https://github.com/pace-neutrons/horace-euphonic-interface
url: https://horace-euphonic-interface.readthedocs.io
keywords:
  - "MATLAB"
  - "physics"
  - "phonons"
  - "inelastic neutron scattering"
  - "CASTEP"
  - "Phonopy"
  - "Horace"
  - "Euphonic"

GitHub Events

Total
  • Create event: 1
  • Release event: 1
  • Issues event: 1
  • Issue comment event: 1
Last Year
  • Create event: 1
  • Release event: 1
  • Issues event: 1
  • Issue comment event: 1

Dependencies

.github/workflows/create-landing-page.yml actions
  • EndBug/add-and-commit v9 composite
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
.github/workflows/run_tests.yml actions
  • EnricoMi/publish-unit-test-result-action v2 composite
  • actions/checkout v3 composite
  • actions/download-artifact v3 composite
  • actions/upload-artifact v3 composite
  • codecov/codecov-action v3 composite
  • conda-incubator/setup-miniconda v2 composite
  • matlab-actions/run-command v1 composite
  • matlab-actions/setup-matlab v1 composite
doc/requirements.txt pypi
  • sphinx ==7.4.7
  • sphinx_rtd_theme ==2.0.0