EurySpace by zguig52

Space Communication System based on CCSDS recommandations
-------------------------------
Project: EurySPACE
Version: 1.0.0
-------------------------------
Author(s):
Guillaume REMBERT
-------------------------------
License:
MIT - Please read LICENSE file for more information
-------------------------------


-------------------------------
         README INDEX
-------------------------------
0 - Project Presentation
-------------------------------
This section presents the EurySPACE project.
Start first by reading these lines.
-------------------------------
1 - Repository Structure
-------------------------------
This section presents the repository structure.
Read these lines to understand the files layout.
-------------------------------
2: Integration Methodology
-------------------------------
This section presents a methodology to be used to integrate the solution.
Read these lines to check and/or define your integration plan.
-------------------------------
3: Development Guidelines
-------------------------------
This section presents coding style conventions.
Read these lines to modify and/or extend the system.
-------------------------------
4: Quick Start
-------------------------------
This section summarizes what is needed to setup and run the solution.
Read these lines to build, install and start the system.
-------------------------------


-------------------------------
 PART 0 - PROJECT PRESENTATION
-------------------------------
FIXME: TBD / Features, supported platforms, etc
-------------------------------


-------------------------------
 PART 1 - REPOSITORY STRUCTURE
-------------------------------
\ cfg (ConFiGuration): configuration files
-------------------------------
    \ hw (HardWare): TBD
    \ sw (SoftWare): TBD
-------------------------------
\ doc (DOCumentation): documentation
-------------------------------
    \ ddd (Detailed Design Document): architecture, algorithms and design details
    \ icd (Interface Control Document): API, internal and external files formats description
    \ trp (Test RePorts): stable releases test reports
    \ ugd (User GuiDe): installation, configuration and use guide
-------------------------------
\ gis (Geographical Information System): GIS data
-------------------------------
    \ gml (Geographical Markup Language): TBD
    \ shp (SHaPe Files): TBD
-------------------------------
\ hw (HardWare): hardware data
-------------------------------
    \ bom (Bill Of Materials)
    \ cad (Computer Aided Design)
    \ dts (DaTaSheets)
    \ grb (GeRBers)
    \ rtl (Register Transfer Level)
        \ ccsds_rxtx (CCSDS Receiver-Emitter)
        \ euryspace_soc (EURYSPACE System On Chip)
----
apm = Analog Processing Module
dpm = Digital Processing Module
iui = Information Universe Interface
-------------------------------
\ sim (SIMulation): simulation tools and data-sets
-------------------------------
    \ dat (raw DATa)
    \ grc (GnuRadio Companion)
    \ oct (OCTave)
    \ qemu (QEMU)
    \ smp (SaMPles)
-------------------------------
\ sw (SoftWare): software data
-------------------------------
    \ bin (BINaries): qualified binaries
        \ RELEASE_VERSION_X.XX.XX
            \ SOFTWARE_NAME-or1k_X.XX.XX-gcc_X.XX.XX-newlib_X.XX.XX
    \ pkg (PacKaGes): platform specific installation packages
        \ RELEASE_VERSION_X.XX.XX
            \ SOFTWARE_NAME
                \ apk: Android
                \ bsd: BSD Unix
                \ deb: Debian/Ubuntu Linux
                \ ios: iOS
                \ rpm: RedHat/CentOS/Fedora/OpenSUSE Linux
                \ win: Windows
    \ src (SouRCes): software source code
        \ ground_segment
            \ core
                \ control
                \ display
                \ emission
                \ process
                \ reception
        \ space_segment
            \ core
                \ control
                \ emission
                \ reception
            \ application
                \ localisation
                \ observation
                \ telecommunication
            \ test
                \ hello_universe
        \ user_segment
            \ core
                \ display
                \ emission
                \ reception
            \ application
                \ localisation
                \ observation
                \ telecommunication
        \ euryspace_test_center
            \ calibration
            \ emission
            \ reception
-------------------------------
\ tst (TeST): test tools and data-sets
-------------------------------
    \ rtl
        \ ccsds_rxtx_bench
        \ euryspace_soc_bench
    \ sh (SHell)
        \ euryspace_auto_calibration
        \ euryspace_auto_test
-------------------------------


-------------------------------
PART 2: INTEGRATION METHODOLOGY
-------------------------------
FIXME: TBD / Specs -> Design -> Code -> Test
-------------------------------


-------------------------------
 PART 3: DEVELOPMENT GUIDELINES
-------------------------------
FIXME: TBD / variables / functions / comments / ...
-------------------------------


-------------------------------
      PART 4: QUICK START
-------------------------------
FIXME: TBD / HW and SW requirements, OS setup, build, install, test
-------------------------------
The MIT License (MIT)

Copyright (c) 2016 Euryece Telecom

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Project Meta

  • Registered 1 year ago
  • Started 2 years ago
  • Last commit 1 year ago

Commits

{"labels":[2016,2017,2018],"series":[["21","3",null]]}

Commits per year

Contributors

{"labels":[2016,2017,2018],"series":[["2","1",null]]}

Unique contributors per year

Releases

Data not available

Languages

{"labels":["Others","VHDL","Verilog-SystemVerilog","Bourne Shell","Assembly","make"],"series":[4,31,9,2,2,2]}

Share of languages used

Data Sheet
https://github.com/euryecetelecom/euryspace.git
MIT
Last updated 1 year ago
Language: VHDL
24 commits by 2 contributors
Guillaume REMBERT Guillaume REMBERT

Activity in last 1 year

Updated 1 year ago