MaxEnt

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
• Usage
• Documentation
• Author
• Citing MaxEnt
• License
• Institutional Support
• 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:

   git clone https://github.com/americocunhajr/MaxEnt.git
   

2. Navigate to the code directory:

   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.

<img src="logo/mit_license_red.png" width="10%">

Institutional support

<img src="logo/logo_uerj.png" width="13%">

Funding

<img src="logo/faperj.png" width="20%">     <img src="logo/cnpq.png" width="20%">     <img src="logo/capes.png" width="10%">