semvec/pypi-packages huggingface dataset:
mispr 0.0.4
mispr contains FireWorks workflows for Materials Science
Requires Python: >=3.6

# <img alt="mispr" src="docs/logo.png" width="500">

[![Downloads](https://pepy.tech/badge/mispr)](https://pepy.tech/project/mispr)
[![GitHub tag](https://img.shields.io/github/tag/molmd/mispr)](https://GitHub.com/molmd/mispr/tags/)

[![Codacy Badge](https://app.codacy.com/project/badge/Grade/8c047110974a42af9baed409664d2547)](https://www.codacy.com/gh/molmd/mispr/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=molmd/mispr&amp;utm_campaign=Badge_Grade)
![Website](https://img.shields.io/website?down_message=down&label=mispr%20website&up_message=up&url=https%3A%2F%2Fmolmd.github.io%2Fmispr%2F)
![GitHub commit activity](https://img.shields.io/github/commit-activity/m/molmd/mispr)

**Rasha Atwi, Matthew Bliss, and Nav Nidhi Rajput**

**Stony Brook University**

## Overview 
MISPR is a software that executes, manages, and stores computational materials science 
simulations. It contains pre-defined density functional theory (DFT) and molecular dynamics (MD) workflows to calculate and analyze different 
properties of materials. MISPR uses [MDPropTools](https://github.com/molmd/mdproptools) to perform MD analysis.

## Installation
You can either download the source from GitHub and compile yourself, or install directly using pip. 
Please see the [Installation](https://molmd.github.io/mispr/html/installation/index.html) page for detailed instructions.

## Useful Links
- [MISPR Website](https://molmd.github.io/mispr/): Visit this site to get an overview of MISPR, check the installation instructions, and follow MISPR tutorials
- [MISPR API Reference](https://molmd.github.io/mispr/html/py-modindex.html)
- [Resources](https://molmd.github.io/mispr/html/resources/resources.html)

## How to cite
Please include the following two citations if MISPR and/or MDPropTools were used for an academic study:
- Atwi, R., Bliss, M., Makeev, M., & Rajput, N. N. (2022). [MISPR: An automated infrastructure for high-throughput DFT and MD simulations](https://www.nature.com/articles/s41598-022-20009-w). Scientific Reports, 12(1), 1-16.
- Atwi, R., Chen, Y., Han, K. S., Mueller, K. T., Murugesan, V., & Rajput, N. N. (2022). 
[An automated framework for high-throughput predictions of NMR chemical shifts within liquid solutions](https://doi.org/10.1038/s43588-022-00200-9). 
Nature Computational Science, 2(2), 112-122.

## License Information
MISPR is a free, open-source software package (distributed under the [MIT license](https://github.com/molmd/mispr/blob/master/LICENSE)).
freefang-qt 0.2.0
A PySide client for the FreeFang werewolf gameserver.

# freefang-qt
A QT client for FreeFang made using PySide
This client is the reference client for FreeFang.


# Installation

## pip (crossplatform)
freefang-qt is published on pypi under the name `freefang-qt`.  
So to install it via pypi and run it run the following.  
```
python -m pip install freefang-qt
python -m freefang_qt.main
```  
You can also simply run freefang-qt if it is in your PATH.  

## Release exe (windows)
Since 0.1.2, freefang-qt offers a windows executable for each release built with pyinstaller.  
Simply grab the Windows_exe.zip file from a release, unzip it, and run the exe file inside.  

## SOON: Flatpak (linux)
freefang-server 0.4.1
The server for FreeFang, a libre python implementation of Werewolf (also known as Mafia)

# FreeFang
 A free implementation of [Werewolf](https://en.m.wikipedia.org/wiki/Mafia_(party_game)) (also known as Mafia) in python.
 Currently in beta, however it is usable and all core features are implemented.

# Gameplay
This game opposes two sides, the werewolves (minority) and the town (majority).
The goal of the town is to exterminate the werewolves and the goal of the werewolves is to reach numerical parity with the town.
The game happens in a cycle of night and day. During the night roles with different powers (such as finding out the role of another player) wake up and the werewolves vote to kill one non-werewolf.
During the day the town (with the werewolves hidden among them) vote to kill one player which they suspect to be a werewolf. The town does not know who the werewolves are and rely on clues/info given to them by the different roles.

This game is about social deduction, lying, persuasion, finding and using clues, etc.

# Getting started
The FreeFang server is available on pypi as `freefang-server`.  
To get started with hosting simply run  

`python -m pip install freefang-server`  
`freefang-server`  

For all the options available run `freefang-server -h`
# Features

- Full werewolf experience with quite a few roles to pick from.  
- No moderator needed, the server takes care of everything from role attribution to voting to role actions.  
- Create a custom ruleset on game creation with only the roles you want and more custom options!.  
- No signup, enter a server, game id, pick a name and you're good.  
- Selfhostable, very simple to get started with.


# Clients

[freefang-qt](https://github.com/FreeFangGame/freefang-qt) is the reference client written by the devs.
You are free to write your own and PR to have it added here, full protocol documentation is coming.


# Protocol documentation

Full protocol documentation in PROTOCOL.md with examples and complete descriptions.   


# Contribute
There are many ways you can help the FreeFang project and we would be extremely thankful.
Those include but aren't limited to:

- Contributing code
- Contributing ideas
- Hosting a server
- Writing a client
- Finding and reporting bugs
- Testing on different platforms (Windows, MacOS, *BSD)
- Spreading the word about FreeFang