<commit_before>SPyFFI
======

The Spiffy Python for Full Frame Images package is a collection of tools for simulating TESS images. They were created by <NAME>, with contributions from <NAME>, <NAME>, and <NAME>.

### basic usage

Once you have it installed, you should be able to start to play, either through the command line in `ipython` or through a script, by creating an "Observation" object, and then using that Observation's create() method to generate all its exposures. Observation takes as an input a Python dictionary, which contains the various input parameters (whether you want a test pattern or stars drawn from the real sky, whether images should be jittered, whether stars should be given cartoon light curves, how many exposures of each cadence to make, etc...). An introduction to some of the parameters you may want to change is available in 'scripts/demonstration.py', or you could try the following from an ipython prompt:

    from SPyFFI.Observation import Observation, default
    o = Observation(default)
    o.create()

### other information

For installation instructions, please see
[`INSTALL.md`](https://github.com/zkbt/SPyFFI/blob/master/INSTALL.md)

For a more introduction on how to use this github repository, please see [`git_tutorial.md`](https://github.com/zkbt/SPyFFI/blob/master/git_tutorial.md).<commit_msg>Fix broken link in README<commit_after>SPyFFI
======

The Spiffy Python for Full Frame Images package is a collection of tools for simulating TESS images. They were created by <NAME>, with contributions from <NAME>, <NAME>, and <NAME>.

### basic usage

Once you have it installed, you should be able to start to play, either through the command line in `ipython` or through a script, by creating an "Observation" object, and then using that Observation's create() method to generate all its exposures. Observation takes as an input a Python dictionary, which contains the various input parameters (whether you want a test pattern or stars drawn from the real sky, whether images should be jittered, whether stars should be given cartoon light curves, how many exposures of each cadence to make, etc...). An introduction to some of the parameters you may want to change is available in 'scripts/demonstration.py', or you could try the following from an ipython prompt:

    from SPyFFI.Observation import Observation, default
    o = Observation(default)
    o.create()

### other information

For installation instructions, please see
[`INSTALL.md`](https://github.com/TESScience/SPyFFI/blob/master/INSTALL.md)
{'fraction_non_alphanumeric': 0.07229386479093396, 'fraction_numerical': 0.0, 'mean_word_length': 4.778781038374718, 'pattern_counts': {'":': 0, '<': 11, '<?xml version=': 0, '>': 11, 'https://': 3, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5149032', 'n_tokens_mistral': 665, 'n_tokens_neox': 637, 'n_words': 345}