About LG4X-V2

LG4X-V2 is an open-source GUI for X-ray photoemission spectroscopy (XPS) curve fitting based on the python lmfit package. It streamlines the fitting process for easier validation and consistency. It is inspired by its predecessor software LG4X by Hideki Nakajima.

LG4X-V2 is build upon the ‘lmfit’-package using ‘PyQt5’ for the GUI.

Cite the project

If LG4X-V2 has been significant in your research, and you would like to acknowledge the project in your academic publication, we suggest citing the software using zenodo:

You can use our CITATION.cff too to generate a citation.

License

LG4X-V2 is distributed under MIT license.

Contributing

We would love your help, either as ideas, documentation, or code. If you have a new algorithm or want to add or fix existing code, please do! Here’s how you can get started:

Fork the LG4X-V2 repository on GitHub.
Clone your forked repository by running the command: git clone https://github.com/<your name>/LG4X-V2.git.
Install all dependencies by running pip install -r requirements.txt.
Create a new branch for your awesome new feature with git checkout -b <awesome_new_feature>.
Start coding!
Verify that your feature does not break anything.
Push your changes to your fork by running git push origin.
Open a pull request on the LG4X-V2 repository.

If you need any additional help, please visit our GitHub discussions page.

Thank you to the contributors of LG4X-V2!

Code of Conduct

LG4X-V2 is committed to fostering a welcoming community. Please have a look at our Code of Conduct.