kartikmandar commited on
Commit
37b4376
·
1 Parent(s): 8f4d60e

Update README: document sample data files and explain large file exclusion

Browse files
Files changed (1) hide show
  1. README.md +13 -0
README.md CHANGED
@@ -249,6 +249,19 @@ Supported formats:
249
  - ASCII tables
250
  - ECSV files
251
 
 
 
 
 
 
 
 
 
 
 
 
 
 
252
  ### Analysis Tools
253
 
254
  1. **Event List Operations**
 
249
  - ASCII tables
250
  - ECSV files
251
 
252
+ #### Sample Data Files
253
+
254
+ The repository includes small sample data files (< 1MB total) in `files/data/` for basic testing:
255
+ - Small event lists (.evt files)
256
+ - Example light curves (.fits files)
257
+
258
+ **Note**: Large sample files (HDF5, RMF > 10MB) are not included in the repository to keep the codebase lightweight and deployable on free-tier hosting platforms like Hugging Face Spaces.
259
+
260
+ For full-scale analysis:
261
+ - Upload your own data files using the "Read Data" feature
262
+ - Load data directly from URLs
263
+ - Download X-ray astronomy datasets from archives like [HEASARC](https://heasarc.gsfc.nasa.gov/)
264
+
265
  ### Analysis Tools
266
 
267
  1. **Event List Operations**