enigma-simulator
enigma-simulator copied to clipboard
NationalSecurityAgency
Nice idea - but how the heck does one use it?
Traditionally, the README tells the user what this thing is, and how to use it. Your README does rather little of the first (yeah, I figure - an Enigma simulator "simulates the workings of an Enigma machine" - very enlightening), and none of the second.
So, how does one use it? Also, how/with-what does one read your .ipynb documents? Might you spare a word or two on this in your README?
Here's are some example of how such projects can be documented:
- http://users.telenet.be/d.rijmenants/en/enigmasim.htm
- https://www.cryptomuseum.com/crypto/usa/kl7/
- http://users.telenet.be/d.rijmenants/en/kl-7sim.htm
See https://github.com/NationalSecurityAgency/enigma-simulator/blob/master/MasterEnigmaCracker.ipynb It's intended to be run in Jupyter Notebook.
It's intended to be run in Jupyter Notebook.
Thanks - it would be nice if the README mentioned that.
Also, would you consider that Jupyter Notebook may not be the most common piece of software? I.e., providing a format less dependent on Jupyter might be nice?
It's intended to be run in Jupyter Notebook.
Thanks - it would be nice if the README mentioned that.
Also, would you consider that Jupyter Notebook may not be the most common piece of software? I.e., providing a format less dependent on Jupyter might be nice?
I don't know anything about Jupyter Notebook. It might be nice to have it in a different format... but then it might not have met the original goals of its author. Perhaps it was published specifically for a group of Jupyter Notebook users? I don't know. I'm not the author, and do not know if this project is currently being maintained.
@ctubbsii can you merge PRs for this project? Not that I have one ready - just trying to figure if it's worth bothering.
@mouse07410 I don't have expertise for this project. My understanding is that this project's main audience was a specific STEM outreach program's participants. I'm not qualified to determine whether any specific change aligns with its intent. If a pull request is made, I would need to try to find a domain expert to accept or reject the proposed change.
Jupyter Notebook seems to be... not the most common piece of software. I have it only because when I attended my college's Python classes, they recommended me to install Anaconda, which is a Python distribution and apparently includes Jupyter Notebook in it. I suspect that regular Python users would normally not have Jupyter Notebook...
(btw, if one has ever used Jupyter Notebook, he/she would recognize the .ipynb extension name. The problem is that it's likely that one has NOT used Jupyter Notebook...)
On the other hand... it might be some work if one is to make this usable without Jupyter Notebook - Jupyter Notebook seems to have some features that regular python-in-a-command-line-window does not have (I've seen it do things involving displaying graphs and playing audio). Maybe the best thing to do is to just tell people to get Jupyter Notebook somewhere in the README...
On the other hand... it might be some work if one is to make this usable without Jupyter Notebook
I put together a command line interface for the enigma-simulator that simply leverages the existing Python implementation. You are welcome to take a look:
0aa2b5d2685f79ccb85c12dac9fd618522c4206f - Create a Command Line Interface (CLI) for the enigma-simulator
If this enigma-simulator project is still being maintained I can submit a related pull request if there is interest. The CLI commit referenced above consists of a single file, the CLI implementation, with no changes made to other project files. However, as ctubbsii commented above providing a non-Jupyter format may go against the intent of the project. Regardless, folks are welcome to grab the CLI/commit and give it try.
Read .ipynb documents using these steps. Open a terminal and type this
pip install jupyterlab
jupyter notebook
open the link shown in a web browser, like http://localhost:8888/ Now click on one of the ipynb files
