tardis/data/tardis_example_config.yml is not a valid config file

[lukeshingles]

Just to get tardis started on something, I tried running 'tardis tardis_example_config.yml output_spectrum.dat' in the folder 'tardis/data', which resulted in the yaml parsing errors.

It looks like this file is an old version of tardis_example.yml from https://www.dropbox.com/s/svvyr5i7m8ouzdt/tardis_example.tar.gz

So a couple of possible solutions:

• remove the file from the repo (in case anyone other than me is confused by its presence)
• update the file to match the tardis_example.tar.gz version (with the small atomic database)
• add the tardis example files to the repository (using git LFS for the 74MB atomic database)

[lukeshingles]

It looks like atom_data.h5 isn't a valid atomic database for the current version either, so option 2 doesn't work easily.

[wkerzendorf]

@lukeshingles A couple of points. TARDIS or other python packages should not be run from within their structure. the data directory should only be used for TARDIS internal data.

I think for now we leave them as is (as the documentation is not pointing in this direction), but we'll leave this issue open to remind us to clean this in the future.

does this sound like a plan @lukeshingles ?

[unoebauer]

@wkerzendorf independently of whether or not one should run tardis within its own structure, I think @lukeshingles has a point. Doesn't make much sense to keep stuff around which is deprecated and/or incompatible with the current code.

[unoebauer]

With the current config (@ftsamis) system, this example file still crashes

ScannerError: while scanning a simple key
  in "tardis_example_config.yml", line 39, column 9
could not found expected ':'
  in "tardis_example_config.yml", line 40, column 9

Still some work to do :)

[wkerzendorf]

The example files should be deleted in the data directory

[ftsamis]

@wkerzendorf I was thinking the same, but on the other hand, I prefer having the example yml file version controlled, rather than in an arbitrary zip file somewhere.

Would it be a good idea now that we have https://github.com/tardis-sn/tardis-atomdata to change the documentation a bit so it directs users to fetch the yml from tardis-sn/tardis branch and the atom data from the tardis-sn/tardis-atomdata branch? If not, the example files should be indeed removed from the branch.

Edit: Maybe, even better, create a new repo tardis-sn/tardis-example which would track a tardis_example.yml and any other text files and have an external reference (with git submodule) to the atomdata

Edit 2: This is an example of what it would look like: https://github.com/ftsamis/tardis-example. Not sure if it will be very helpful though, since the atomic data are zipped, and one would have to download the other h5 files from the atomdata repo too.

[wkerzendorf]

@ftsamis - the example file will likely go away and unseres will only download the atomic data file and look at examples in the documentation

[unoebauer]

Let's clean up the tardis working tree for 2.0

[unoebauer]

Resolved by #797.