https://github.com/americocunhajr/maxent
MaxEnt is a Matlab toolbox for the calculation of maximum entropy distributions and the corresponding statistical samples from a given set of known information.
https://github.com/americocunhajr/maxent
maximum-entropy numerical-methods parametric-inference statistical-inference stochastic-modelling uncertainty-quantification
Last synced: about 1 year ago
JSON representation
MaxEnt is a Matlab toolbox for the calculation of maximum entropy distributions and the corresponding statistical samples from a given set of known information.
- Host: GitHub
- URL: https://github.com/americocunhajr/maxent
- Owner: americocunhajr
- License: mit
- Created: 2020-08-22T18:18:23.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2025-04-04T19:02:16.000Z (about 1 year ago)
- Last Synced: 2025-04-23T01:47:04.363Z (about 1 year ago)
- Topics: maximum-entropy, numerical-methods, parametric-inference, statistical-inference, stochastic-modelling, uncertainty-quantification
- Language: MATLAB
- Homepage: https://americocunhajr.github.io/MaxEnt
- Size: 1.2 MB
- Stars: 7
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Maximum Entropy Code
**MaxEnt: Maximum Entropy Code** is a user-friendly Matlab package designed for calculating maximum entropy distributions and generating corresponding statistical samples from a given set of known information. The implementation is numerically robust and follows an educational style, making it intuitive and accessible. The package includes examples with representative benchmark tests to illustrate its functionality.
## Table of Contents
- [Features](#features)
- [Usage](#usage)
- [Documentation](#documentation)
- [Author](#author)
- [Citing MaxEnt](#citing-maxent)
- [License](#license)
- [Institutional Support](#institutional-support)
- [Funding](#funding)
### Features
- Calculates maximum entropy distributions from known information
- Generates statistical samples based on maximum entropy distributions
- Numerically robust implementation
- Educational style for ease of use
- Includes examples with benchmark tests
## Usage
To get started with **MaxEnt**, follow these steps:
1. Clone the repository:
```bash
git clone https://github.com/americocunhajr/MaxEnt.git
```
2. Navigate to the code directory:
```bash
cd MaxEnt/MaxEnt-1.0
```
### Documentation
**MaxEnt** routines are thoroughly commented to explain their functionality. Each routine includes a short description of its purpose and a list of inputs and outputs. Examples with a few, but representative, benchmark tests are provided to illustrate the code's functionality.
### Author
- Americo Cunha Jr
### Citing MaxEnt
We kindly ask users to cite the following reference in any publications reporting work done with **MaxEnt**:
- *A. Cunha Jr, MaxEnt - Maximum Entropy Code, GitHub repository, 2020*
```
@misc{CunhaJr2020MaxEnt,
author = {A. {Cunha~Jr}},
title = { {MaxEnt} - {M}aximum {E}ntropy {C}ode},
year = {2020},
publisher = {GitHub},
journal = {GitHub repository},
howpublished = {\url{https://MaxEntCode.org}},
}
```
### License
**MaxEnt** is released under the MIT license. See the LICENSE file for details. All new contributions must be made under the MIT license.
### Institutional support
### Funding
