Skip to content

ricardoedgarsilva/PyCharMem

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

72 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation



Explore the docs »

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

PyCharMem is a robust Python-based software, engineered to perform electrical characterization on memristive devices. It conducts these measurements under a range of conditions dictated by a user-configured file, thereby offering a great deal of flexibility and control.

Developed by Ricardo E. Silva, PyCharMem is openly licensed under the GNU General Public License v3.0, with the source code readily accessible on GitHub, promoting transparency and community-based enhancements.

PyCharMem furnishes both a command-line interface (CLI) and a graphical user interface (GUI). The CLI permits users to select a specific measurement type, key in the necessary parameters, and initiate the measurement. Simultaneously, the GUI presents an intuitive platform for real-time results visualization, enhancing user understanding and interaction.

The inception of PyCharMem traces back to a comprehensive research project at INESC-MN Lisbon, Portugal, a testament to its scientific rigor and reliability.

(back to top)

Built With

This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

  • Python
  • YAML

(back to top)

Getting Started

Prerequisites

PyCharMem is compatible with all operating systems that support Python 3.9 or above. This guide will walk you through the steps necessary to install Python 3.9 or a newer version. Afterward, you'll need to acquire a National Instruments GPIB card and install the specific NI-VISA drivers for your case. If your device is not listed in the /instruments directory, you will need to generate a file using the "template.py" file provided in the same folder. This will serve as a communication bridge between your device and the system, effectively functioning as an API.

(back to top)

Installation

Once you have cloned the repository or downloaded a particular release, it's essential to install the necessary dependencies. Here's how you can proceed with the process:

Firstly, you will need to install the Python requirements. Execute the following command to do so:

  pip install -r requirements.txt

(back to top)

Usage

In order to run the program open a terminal window and run the following command:

  python PyCharMem.py

For more, please refer to the documentation.

(back to top)

Roadmap

  • Create documentation
  • Add step measurements

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the GNU General Public License v3.0.

(back to top)

Contact

Personal Website: Link

(back to top)

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

(back to top)

About

PyCharMem is a Python-based software for characterizing memristors

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages