Documentação

Visão geral do sistema

Nosso software foi desenvolvido para ser utilizado juntamente com o módulo N957 da CAEN, que realiza a função essencial de coletar dados e armazena-os num buffer de saída com os picos da entrada convertidos para valores discretos. Com a ajuda da biblioteca N957Lib, configuramos a placa e extraímos os dados do buffer pela porta USB. Utilizamos esses valores para criar um histograma dos níveis de energia que o módulo detecta. Esse histograma é atualizado em tempo-real, e a medição pode ser encerrada a qualquer momento, quando o histograma final e um registro são salvos.

Nossa aplicação é um software livre, licenciado pela Licença Pública do GNU versão 3 (GNU GPL v3). Ela foi desenvolvida no Centro de Tecnologia Acadêmica para aplicações no Laboratório de Implantação Iônica, pertencente ao Instituto de Física da Universidade Federal do Rio Grande do Sul (UFRGS).

[ propósito do software
características mais importantes do software
diferencial do sistema desenvolvido
usuários-alvo
desenvolvedores]

Sistema-alvo

Estação de desenvolvimento¶

O software foi desenvolvido no ambiente de trabalho Gnome versão 3.4.2. no processador Intel® Pentium® CPU G2030 @ 3.00 Ghz x 2. A aplicação executa com boa performance nessa plataforma, portanto uma CPU semelhante ou de maior poder de computação que a nossa é recomendada. Segundo o Manual de Informações Técnicas do módulo, que pode ser encontrada na pasta 'docs' de nossa aplicação, a taxa de transferência de dados dependerá dessas capacidades da plataforma e do tamanho de bloco a ser lido, definido pela função N957_ReadData.

Estrutura do sistema

A separação do código da aplicação em diferentes categorias melhora a visão do sistema como um todo. Nosso sistema é composto de seis blocos, descritos a seguir.
Blocos que compõem o sistema

doc: contém documentação, licenças, e informações gerais sobre o sistema

include: contém headers dos arquivos C

lib: contém arquivos em linguagem C, que recuperam os dados do buffer do módulo CAEN e guardam os dados do histograma a ser construído

N957: contém as bibliotecas do módulo CAEN

python: contém os arquivos na linguagem Python, que recebem os dados gerados pelo código C e fazem a interface da aplicação com o usuário.

Save: contém os registros (.log) da aplicação e os dados em formato texto do histograma final.

[ descrição dos blocos que compõem o sistema (escrita/algo parecido com um diagrama de classes)]

Uso

Na página de uso você encontra instruções de instalação e de utilização.