Add Docs for Setup and Initial Interaction

Project.toml

@@ -4,30 +4,32 @@ authors = ["Aman Pandey"]
 version = "0.1.0"
 
 [deps]
-FFTW = "7a1cc6ca-52ef-59f5-83cd-3a7055c09341"
-Distributions = "31c24e10-a181-5473-b8eb-7969acd0382f"
-ResumableFunctions = "c5292f4c-5179-55e1-98c5-05642aab7184"
-StatsBase = "2913bbd2-ae8a-5f71-8c99-4fb6c76f3a91"
-Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"
-ProgressBars = "49802e3a-d2f1-5c88-81d8-b72133a6f568"
 DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
-HDF5 = "f67ccb44-e63f-5c2f-98bd-6dc0ccc4ba2f"
-NaNMath = "77ba4419-2d1f-58cd-9bb1-8ffee604a2e3"
+Distributions = "31c24e10-a181-5473-b8eb-7969acd0382f"
+FFTW = "7a1cc6ca-52ef-59f5-83cd-3a7055c09341"
 FITSIO = "525bcba6-941b-5504-bd06-fd0dc1a4d2eb"
+HDF5 = "f67ccb44-e63f-5c2f-98bd-6dc0ccc4ba2f"
 Intervals = "d8418881-c3e1-53bb-8760-2df7ec849ed5"
+NaNMath = "77ba4419-2d1f-58cd-9bb1-8ffee604a2e3"
+ProgressBars = "49802e3a-d2f1-5c88-81d8-b72133a6f568"
+ResumableFunctions = "c5292f4c-5179-55e1-98c5-05642aab7184"
+Revise = "295af30f-e4ad-537b-8983-00126c2a3abe"
+Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"
+StatsBase = "2913bbd2-ae8a-5f71-8c99-4fb6c76f3a91"
 
 [compat]
-julia = "1.11"
-FFTW = "1.4"
-Distributions = "0.25"
-ResumableFunctions = "0.6"
-StatsBase = "0.33"
-ProgressBars = "1.4"
 DataFrames = "1.3"
-HDF5 = "0.16"
+Distributions = "0.25"
+FFTW = "1.4"
 FITSIO = "0.16"
+HDF5 = "0.16"
 Intervals = "1.8"
 NaNMath = "0.3, 1"
+ProgressBars = "1.4"
+ResumableFunctions = "0.6"
+Revise = "3.7.2"
+StatsBase = "0.33"
+julia = "1.11"
 
 [extras]
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"

docs/Project.toml

@@ -2,4 +2,4 @@
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 
 [compat]
-Documenter = "0.27"
+Documenter = "0.27"

docs/make.jl

@@ -6,11 +6,11 @@ DocMeta.setdocmeta!(Stingray, :DocTestSetup, :(using Stingray); recursive=true)
 makedocs(;
     modules=[Stingray],
     authors="Aman Pandey",
-    repo="https://github.com/matteobachetti/Stingray.jl/blob/{commit}{path}#{line}",
+    repo=Remotes.GitHub("StingraySoftware", "Stingray.jl"),
     sitename="Stingray.jl",
     format=Documenter.HTML(;
         prettyurls=get(ENV, "CI", "false") == "true",
-        canonical="https://github.com/matteobachetti/Stingray.jl",
+        canonical="https://github.com/StingraySoftware/Stingray.jl",
         edit_link="master",
         assets=String[],
     ),
@@ -20,6 +20,8 @@ makedocs(;
 )
 
 deploydocs(;
-    repo="https://github.com/matteobachetti/Stingray.jl",
+    repo="https://github.com/StingraySoftware/Stingray.jl",
     devbranch="main",
+    target="build",
+    push_preview=true
 )

docs/src/index.md

@@ -1,14 +1,76 @@
-```@meta
-CurrentModule = Stingray
+## Stingray: Next-Generation Spectral Timing
+# Overview 
+
+Stingray is a Julia library designed to perform time series analysis and related tasks on astronomical light curves. It supports a range of commonly used Fourier analysis techniques, as well as extensions for analyzing pulsar data, simulating datasets, and statistical modeling. Stingray is designed to be easy to extend and incorporate into data analysis workflows and pipelines.
+
+# Features
+
+## Current Capabilities
+
+### 1. Data Handling and Simulation
+
+- Good Time Interval (GTI) operations
+
+### 2. Fourier Methods
+
+- Basic Fourier transformations
+
+### 3. Testing Framework
+
+- Includes test cases for GTI and Fourier transformations
+- Sample event list data for validation
+
+## Future Plans
+
+We welcome feature requests! If you need a particular tool that is not currently available or have a new method that could be useful in Stingray.jl, please contribute or open an issue.
+
+### Upcoming Features
+
+- **Power spectra calculations**
+- **Extended power spectra and cross spectra support**
+- **More comprehensive time series operations**
+- **Advanced pulsar search methods**
+
+# Installing Development Environment (For New Contributors)
+
+For those of you wanting to contribute to the project, install the bleeding-edge development version from source. First, fork our repository on GitHub and clone the forked repository using:
+
+```sh
+$ git clone --recursive https://github.com/<your-github-username>/stingray.jl.git
 ```
 
-# Stingray
+Now, navigate to this folder and run the following command to add an upstream remote that’s linked to Stingray’s main repository. (This will be necessary when submitting PRs later.):
+
+```sh
+$ cd stingray.jl
+$ git remote add upstream https://github.com/StingraySoftware/stingray.jl.git
+```
 
-Documentation for [Stingray](https://github.com/matteobachetti/Stingray.jl).
+# Installation
+### Setting up in VS Code
 
-```@index
+1. Open Julia REPL
+   - Press `Ctrl + Shift + P`
+   - Search for `julia:start REPL` and select it
+2. Navigate to the Cloned Repository in REPL:
+
+```julia
+cd("C:\\Users\\Stingray.jl")
 ```
 
-```@autodocs
-Modules = [Stingray]
+3. Activate and Install Dependencies:
+
+```julia
+import Pkg
+Pkg.activate(".")
+Pkg.instantiate()
 ```
+
+## Test Suite
+
+Please be sure to run the test suite before you use the package, and report anything you think might be bugs on our GitHub Issues page.
+
+```julia
+using Pkg
+Pkg.test("Stingray")
+```