Skip to content

README_en.md

Latest commit

 

History

History
85 lines (54 loc) · 2.55 KB

README_en.md

File metadata and controls

85 lines (54 loc) · 2.55 KB
Raw

MaiML-Library

🌐 Language: 日本語 | English

MaiML-Library is the GitHub organization for developing shared libraries, SDKs, and APIs for MaiML (Measurement Analysis Instrument Markup Language).

MaiML-Library develops, maintains, and publishes the core libraries and SDKs that serve as the foundation for software working with MaiML. All libraries are designed around a common data model, emphasizing interoperability and reusability.

About MaiML-Library

MaiML-Library is dedicated to developing shared libraries and SDKs for the MaiML ecosystem.

Its primary focus includes:

  • Common data model
  • Software Development Kits (SDKs)
  • APIs
  • Shared libraries
  • Development support tools

These components enable developers to create applications that work with MaiML across a variety of programming languages and platforms.

Repository Structure

MaiML-Domain provides the common data model that serves as the foundation for all libraries developed within MaiML-Library.

The following projects are currently under development.

Repository Description
MaiML-Domain Common data model for MaiML
PyMaiML Python SDK built on MaiML-Domain
PyMaiML-API API built on the Python SDK
PyMaiML-Tools Development support tools built on the SDK and API

Additional SDKs and libraries for other programming languages will be added in the future.

Development Policy

MaiML-Library follows a common data model–centric architecture for all library development.

The basic principles are:

  • Use the common data model (MaiML-Domain) as the foundation for library development.
  • Ensure consistency with the common data model when developing new libraries.
  • Maintain a clear dependency hierarchy centered on the common data model.
  • Design APIs and SDKs with compatibility in mind.
  • Discuss specification changes through Issues and Pull Requests.
  • Record all significant changes in the Change Log.

Contributing

Community contributions are always welcome.

You can contribute by:

  • Developing libraries
  • Improving SDKs
  • Designing APIs
  • Reporting bugs
  • Improving documentation
  • Submitting Pull Requests

Related Links

License

Please refer to the license information provided in each repository.