Isingchat

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Organization
4. Authors
5. Acknowledgments

About the project

A library to calculate the thermodynamic properties of a 1D Ising spin chain with beyond nearest-neighbor interactions.

We explore the regular and irregular Ising chains with different range of interaction

Built With

You can use the following open source package management system

• Conda
• Poetry
• Pip

Getting Started

Prerequisites

It is recommended to create a separate virtual environment for isingchat. If you use conda, it is enough to make a minimal environment with Python 3.7 or greater, for instance,

conda create -n isingchatdev python=3.7

Naturally, other virtual environment managers can be used.

Installation

Isingchat dependencies are managed by poetry, so poetry should be installed in the system. In the project root directory, execute

poetry install

Poetry will take care of the installation process. Afterward, isingchat packages and command-line interface tools should be available in the current shell.

(back to top)

Organization

The project is organized as follows

• src/isingchat/: Source for principal code
  • cli/
  • style/
  • ising.py: Main calculation code
• conda/recipe/: recipes for conda-build construction package
• scripts/
• docs/
  • hardware/
    • cpuinfo: Hardware specifications used
• test/
• notebooks/: Folder with all notebook experiment for thermodynamic analysis
• data/: all data calculated

Authors

Library

Omar Abel Rodríguez López, https://github.com/oarodriguez

Theory and main algorithm

José Guillermo Martínez Herrera

(back to top)